\label{doc_api_review_core_kdbGet_md_md_doc_api_review_core_kdbGet}%
\Hypertarget{doc_api_review_core_kdbGet_md_md_doc_api_review_core_kdbGet}%

\begin{DoxyItemize}
\item start = 2021-\/03-\/20 19\+:10
\item end = 2021-\/03-\/20 19\+:25
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_api_review_core_kdbGet_md_autotoc_md664}{}\doxysection{Signature}\label{doc_api_review_core_kdbGet_md_autotoc_md664}
{\ttfamily int \mbox{\hyperlink{group__kdb_ga28e385fd9cb7ccfe0b2f1ed2f62453a1}{kdb\+Get(\+KDB $\ast$handle, Key\+Set $\ast$returned, Key $\ast$parent\+Key)}}}\hypertarget{doc_api_review_core_kdbGet_md_autotoc_md665}{}\doxysection{Checklist}\label{doc_api_review_core_kdbGet_md_autotoc_md665}
\hypertarget{doc_api_review_core_kdbGet_md_autotoc_md666}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_kdbGet_md_autotoc_md666}
(bullet points are in order of appearance)


\begin{DoxyItemize}
\item \mbox{[} \mbox{]} First line explains briefly what the function does ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} \textquotesingle{}Atomic operation to retrieve Keys from a KDB\textquotesingle{}
\end{DoxyItemize}
\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{]} explain in more detail which keys are included ({\ttfamily \mbox{\hyperlink{group__keytest_ga03332b5d97c76a4fd2640aca4762b8df}{key\+Is\+Below()}}}) ~\newline

\item \mbox{[} \mbox{]} move above description out of {\ttfamily @param}
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Description of functions reads nicely ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} remove indentation from first paragraph in Optimization
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @pre} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} move below description ~\newline

\item \mbox{[} \mbox{]} Key\+Set is not named {\ttfamily returned} anymore
\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{]} {\ttfamily \mbox{\hyperlink{group__keytest_ga03332b5d97c76a4fd2640aca4762b8df}{key\+Is\+Below()}}} for rules on parents / children
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_kdbGet_md_autotoc_md667}{}\doxysubsection{Naming}\label{doc_api_review_core_kdbGet_md_autotoc_md667}

\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{[} \mbox{]} Abbreviations used in parameter names must be defined in the \mbox{\hyperlink{doc_help_elektra-glossary_md}{Glossary}} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} define {\ttfamily ks}
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Parameter names should neither be too long, nor too short ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily ks} -\/$>$ {\ttfamily key\+Set}
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Parameter names should be clear and unambiguous
\end{DoxyItemize}\hypertarget{doc_api_review_core_kdbGet_md_autotoc_md668}{}\doxysubsection{Compatibility}\label{doc_api_review_core_kdbGet_md_autotoc_md668}
(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_kdbGet_md_autotoc_md669}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_kdbGet_md_autotoc_md669}

\begin{DoxyItemize}
\item Function parameters should use enum types instead of boolean types wherever sensible
\item \mbox{[} \mbox{]} Wherever possible, function parameters should be {\ttfamily const} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} handle ~\newline

\item \mbox{[} \mbox{]} parent\+Key
\end{DoxyItemize}
\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_kdbGet_md_autotoc_md670}{}\doxysubsection{Structural Clarity}\label{doc_api_review_core_kdbGet_md_autotoc_md670}

\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_kdbGet_md_autotoc_md671}{}\doxysubsection{Memory Management}\label{doc_api_review_core_kdbGet_md_autotoc_md671}

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

\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_kdbGet_md_autotoc_md673}{}\doxysubsection{Tests}\label{doc_api_review_core_kdbGet_md_autotoc_md673}

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Lines 1185\+:1188 ~\newline

\item \mbox{[} \mbox{]} Lines 1218\+:1220 ~\newline

\item \mbox{[} \mbox{]} Lines 1225\+:1227 ~\newline

\item \mbox{[} \mbox{]} Lines 1262\+:1288 ~\newline

\item \mbox{[} \mbox{]} Lines 1298\+:1310 ~\newline

\item \mbox{[} \mbox{]} Lines 1345\+:1347 ~\newline

\item \mbox{[} \mbox{]} Line 1205 ~\newline

\item \mbox{[} \mbox{]} Line 1234 ~\newline

\item \mbox{[} \mbox{]} Line 1368 ~\newline

\item \mbox{[} \mbox{]} Line 1403 ~\newline

\item \mbox{[} \mbox{]} add {\ttfamily kdb\+Get} specific tests
\end{DoxyItemize}
\item \mbox{[} \mbox{]} All possible error states are covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} parent\+Key namespace is {\ttfamily KEY\+\_\+\+NS\+\_\+\+META} ~\newline

\item \mbox{[} \mbox{]} parent\+Key namespace is {\ttfamily KEY\+\_\+\+NS\+\_\+\+NONE} ~\newline

\item \mbox{[} \mbox{]} {\ttfamily ks == 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_kdbGet_md_autotoc_md674}{}\doxysection{Summary}\label{doc_api_review_core_kdbGet_md_autotoc_md674}
\hypertarget{doc_api_review_core_kdbGet_md_autotoc_md675}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_kdbGet_md_autotoc_md675}
