\label{doc_api_review_core_ksHead_md_md_doc_api_review_core_ksHead}%
\Hypertarget{doc_api_review_core_ksHead_md_md_doc_api_review_core_ksHead}%

\begin{DoxyItemize}
\item start = 2021-\/03-\/09 03\+:00
\item end = 2021-\/03-\/09 03\+:10
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksHead_md_autotoc_md1403}{}\doxysection{Signature}\label{doc_api_review_core_ksHead_md_autotoc_md1403}
{\ttfamily Key $\ast$ks\+Head(const Key\+Set $\ast$ks)}\hypertarget{doc_api_review_core_ksHead_md_autotoc_md1404}{}\doxysection{Checklist}\label{doc_api_review_core_ksHead_md_autotoc_md1404}
\hypertarget{doc_api_review_core_ksHead_md_autotoc_md1405}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_ksHead_md_autotoc_md1405}
(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{[}x\mbox{]} Longer description of function containing common use cases
\item \mbox{[}x\mbox{]} Description of functions reads nicely
\item \mbox{[} \mbox{]} {\ttfamily @pre} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\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{[} \mbox{]} {\ttfamily @return} / {\ttfamily @retval} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} split {\ttfamily @retval} into two lines
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @since} ~\newline

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

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} remove {\ttfamily \mbox{\hyperlink{group__keyset_gabe793ff51f1728e3429c84a8a9086b70}{ks\+Rewind()}}} / {\ttfamily \mbox{\hyperlink{group__keyset_ga317321c9065b5a4b3e33fe1c399bcec9}{ks\+Next()}}}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksHead_md_autotoc_md1406}{}\doxysubsection{Naming}\label{doc_api_review_core_ksHead_md_autotoc_md1406}

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Abbreviations used in function 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{[}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{[}x\mbox{]} Parameter names should neither be too long, nor too short
\item \mbox{[} \mbox{]} Parameter names should be clear and unambiguous ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily ks} -\/$>$ {\ttfamily key\+Set}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksHead_md_autotoc_md1407}{}\doxysubsection{Compatibility}\label{doc_api_review_core_ksHead_md_autotoc_md1407}
(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_ksHead_md_autotoc_md1408}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_ksHead_md_autotoc_md1408}

\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_ksHead_md_autotoc_md1409}{}\doxysubsection{Structural Clarity}\label{doc_api_review_core_ksHead_md_autotoc_md1409}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Functions should do exactly one thing
\item \mbox{[}x\mbox{]} Function name has the appropriate prefix
\item \mbox{[} \mbox{]} Order of signatures in kdb.\+h.\+in is the same as Doxygen ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} fix
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} No functions with similar purpose exist
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksHead_md_autotoc_md1410}{}\doxysubsection{Memory Management}\label{doc_api_review_core_ksHead_md_autotoc_md1410}

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

\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_ksHead_md_autotoc_md1412}{}\doxysubsection{Tests}\label{doc_api_review_core_ksHead_md_autotoc_md1412}

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

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

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} add test case for {\ttfamily ks == NULL} ~\newline

\item \mbox{[}x\mbox{]} add test case for {\ttfamily ks-\/$>$size == 0} ~\newline

\item \mbox{[}x\mbox{]} check if {\ttfamily ks\+Current == NULL} if {\ttfamily ks\+Current == ks\+Head}
\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_ksHead_md_autotoc_md1413}{}\doxysection{Summary}\label{doc_api_review_core_ksHead_md_autotoc_md1413}
\hypertarget{doc_api_review_core_ksHead_md_autotoc_md1414}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_ksHead_md_autotoc_md1414}
