\label{doc_api_review_core_kdbSet_md_md_doc_api_review_core_kdbSet}%
\Hypertarget{doc_api_review_core_kdbSet_md_md_doc_api_review_core_kdbSet}%

\begin{DoxyItemize}
\item start = 2021-\/03-\/20 19\+:10
\item end = 2021-\/03-\/20 19\+:30
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_api_review_core_kdbSet_md_autotoc_md685}{}\doxysection{Signature}\label{doc_api_review_core_kdbSet_md_autotoc_md685}
{\ttfamily int \mbox{\hyperlink{group__kdb_ga11436b058408f83d303ca5e996832bcf}{kdb\+Set(\+KDB $\ast$handle, Key\+Set $\ast$returned, Key $\ast$parent\+Key)}}}\hypertarget{doc_api_review_core_kdbSet_md_autotoc_md686}{}\doxysection{Checklist}\label{doc_api_review_core_kdbSet_md_autotoc_md686}
\hypertarget{doc_api_review_core_kdbSet_md_autotoc_md687}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_kdbSet_md_autotoc_md687}
(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 set Keys for 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{]} move description out of {\ttfamily @param} ~\newline

\item \mbox{[} \mbox{]} add info what happens if keys are read-\/only
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Description of functions reads nicely ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} \textquotesingle{}give a hint\textquotesingle{} -\/$>$ \textquotesingle{}specify\textquotesingle{}
\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{[} \mbox{]} {\ttfamily @param} for every parameter ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} move parent\+Key description to description text
\end{DoxyItemize}
\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{[}x\mbox{]} {\ttfamily @see}
\end{DoxyItemize}\hypertarget{doc_api_review_core_kdbSet_md_autotoc_md688}{}\doxysubsection{Naming}\label{doc_api_review_core_kdbSet_md_autotoc_md688}

\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_kdbSet_md_autotoc_md689}{}\doxysubsection{Compatibility}\label{doc_api_review_core_kdbSet_md_autotoc_md689}
(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_kdbSet_md_autotoc_md690}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_kdbSet_md_autotoc_md690}

\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_kdbSet_md_autotoc_md691}{}\doxysubsection{Structural Clarity}\label{doc_api_review_core_kdbSet_md_autotoc_md691}

\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_kdbSet_md_autotoc_md692}{}\doxysubsection{Memory Management}\label{doc_api_review_core_kdbSet_md_autotoc_md692}

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

\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_kdbSet_md_autotoc_md694}{}\doxysubsection{Tests}\label{doc_api_review_core_kdbSet_md_autotoc_md694}

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Lines 1737\+:1740 ~\newline

\item \mbox{[} \mbox{]} Lines 1745\+:1748 ~\newline

\item \mbox{[} \mbox{]} Lines 1753\+:1756 ~\newline

\item \mbox{[} \mbox{]} Lines 1761\+:1764 ~\newline

\item \mbox{[} \mbox{]} Lines 1796\+:1798 ~\newline

\item \mbox{[} \mbox{]} Lines 1806\+:1809 ~\newline

\item \mbox{[} \mbox{]} Line 1906
\end{DoxyItemize}
\item \mbox{[} \mbox{]} All possible error states are covered by tests ~\newline

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

\item \mbox{[} \mbox{]} {\ttfamily ks == NULL} ~\newline

\item \mbox{[} \mbox{]} {\ttfamily parent\+Key == NULL} ~\newline

\item \mbox{[} \mbox{]} read-\/only parent\+Key
\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_kdbSet_md_autotoc_md695}{}\doxysection{Summary}\label{doc_api_review_core_kdbSet_md_autotoc_md695}
\hypertarget{doc_api_review_core_kdbSet_md_autotoc_md696}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_kdbSet_md_autotoc_md696}
