\label{doc_api_review_core_kdbClose_md_md_doc_api_review_core_kdbClose}%
\Hypertarget{doc_api_review_core_kdbClose_md_md_doc_api_review_core_kdbClose}%

\begin{DoxyItemize}
\item start = 2021-\/03-\/09 01\+:55
\item end = 2021-\/03-\/09 02\+:10
\item moderator = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_api_review_core_kdbClose_md_autotoc_md671}{}\doxysection{Signature}\label{doc_api_review_core_kdbClose_md_autotoc_md671}
{\ttfamily int \mbox{\hyperlink{group__kdb_gadb54dc9fda17ee07deb9444df745c96f}{kdb\+Close(\+KDB $\ast$handle, Key $\ast$error\+Key)}}}\hypertarget{doc_api_review_core_kdbClose_md_autotoc_md672}{}\doxysection{Checklist}\label{doc_api_review_core_kdbClose_md_autotoc_md672}
\hypertarget{doc_api_review_core_kdbClose_md_autotoc_md673}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_kdbClose_md_autotoc_md673}
(bullet points are in order of appearance)


\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} First line explains briefly what the function does
\item \mbox{[} \mbox{]} Simple example or snippet how to use the function ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Longer description of function containing common use cases ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add possible error messages {\ttfamily error\+Key} could contain
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Description of functions reads nicely
\item \mbox{[} \mbox{]} {\ttfamily @pre} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} move below description
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @post} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @invariant} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} {\ttfamily @param} for every parameter
\item \mbox{[}x\mbox{]} {\ttfamily @return} / {\ttfamily @retval}
\item \mbox{[} \mbox{]} {\ttfamily @since} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} {\ttfamily @ingroup}
\item \mbox{[} \mbox{]} {\ttfamily @see} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add {\ttfamily \mbox{\hyperlink{group__kdb_ga844e1299a84c3fbf1d3a905c5c893ba5}{kdb\+Open()}}}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_kdbClose_md_autotoc_md674}{}\doxysubsection{Naming}\label{doc_api_review_core_kdbClose_md_autotoc_md674}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Abbreviations used in function names must be defined in the \mbox{\hyperlink{doc_help_elektra-glossary_md}{Glossary}}
\item \mbox{[}x\mbox{]} Function names should neither be too long, nor too short
\item \mbox{[}x\mbox{]} Function name should be clear and unambiguous
\item \mbox{[}x\mbox{]} Abbreviations used in parameter names must be defined in the \mbox{\hyperlink{doc_help_elektra-glossary_md}{Glossary}}
\item \mbox{[}x\mbox{]} Parameter names should neither be too long, nor too short
\item \mbox{[}x\mbox{]} Parameter names should be clear and unambiguous
\end{DoxyItemize}\hypertarget{doc_api_review_core_kdbClose_md_autotoc_md675}{}\doxysubsection{Compatibility}\label{doc_api_review_core_kdbClose_md_autotoc_md675}
(only in PRs)


\begin{DoxyItemize}
\item \mbox{\hyperlink{doc_dev_symbol-versioning_md}{Symbol versioning}} is correct for breaking changes
\item ABI/\+API changes are forward-\/compatible (breaking backwards-\/compatibility to add additional symbols is fine)
\end{DoxyItemize}\hypertarget{doc_api_review_core_kdbClose_md_autotoc_md676}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_kdbClose_md_autotoc_md676}

\begin{DoxyItemize}
\item Function parameters should use enum types instead of boolean types wherever sensible
\item \mbox{[}x\mbox{]} Wherever possible, function parameters should be {\ttfamily const}
\item \mbox{[}x\mbox{]} Wherever possible, return types should be {\ttfamily const}
\item \mbox{[}x\mbox{]} Functions should have the least amount of parameters feasible
\end{DoxyItemize}\hypertarget{doc_api_review_core_kdbClose_md_autotoc_md677}{}\doxysubsection{Structural Clarity}\label{doc_api_review_core_kdbClose_md_autotoc_md677}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Functions should do exactly one thing
\item \mbox{[}x\mbox{]} Function name has the appropriate prefix
\item \mbox{[}x\mbox{]} Order of signatures in kdb.\+h.\+in is the same as Doxygen
\item \mbox{[}x\mbox{]} No functions with similar purpose exist
\end{DoxyItemize}\hypertarget{doc_api_review_core_kdbClose_md_autotoc_md678}{}\doxysubsection{Memory Management}\label{doc_api_review_core_kdbClose_md_autotoc_md678}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Memory Management should be handled by the function wherever possible
\end{DoxyItemize}\hypertarget{doc_api_review_core_kdbClose_md_autotoc_md679}{}\doxysubsection{Extensibility}\label{doc_api_review_core_kdbClose_md_autotoc_md679}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Function is easily extensible, e.\+g., with flags
\item \mbox{[}x\mbox{]} Documentation does not impose limits, that would hinder further extensions
\end{DoxyItemize}\hypertarget{doc_api_review_core_kdbClose_md_autotoc_md680}{}\doxysubsection{Tests}\label{doc_api_review_core_kdbClose_md_autotoc_md680}

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Function code is fully covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} line 587 ~\newline

\item \mbox{[} \mbox{]} return value never gets checked
\end{DoxyItemize}
\item \mbox{[} \mbox{]} All possible error states are covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add test for {\ttfamily handle == NULl}
\end{DoxyItemize}
\item All possible enum values are covered by tests
\item \mbox{[}x\mbox{]} No inconsistencies between tests and documentation
\end{DoxyItemize}\hypertarget{doc_api_review_core_kdbClose_md_autotoc_md681}{}\doxysection{Summary}\label{doc_api_review_core_kdbClose_md_autotoc_md681}

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} What happens if {\ttfamily error\+Key} is {\ttfamily NULL}?
\end{DoxyItemize}\hypertarget{doc_api_review_core_kdbClose_md_autotoc_md682}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_kdbClose_md_autotoc_md682}

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily \mbox{\hyperlink{group__kdb_ga1ba80a565f54490f362df95f401bcb29}{ks\+Rename\+Keys()}}} in KDB-\/\+Module? 
\end{DoxyItemize}