<html><head><meta name="color-scheme" content="light dark"></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">\label{doc_api_review_core_keyIsDirectlyBelow_md_md_doc_api_review_core_keyIsDirectlyBelow}%
\Hypertarget{doc_api_review_core_keyIsDirectlyBelow_md_md_doc_api_review_core_keyIsDirectlyBelow}%

\begin{DoxyItemize}
\item start = 2021-\/03-\/07 19\+:10
\item end = 2021-\/03-\/07 19\+:20
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyIsDirectlyBelow_md_autotoc_md1002}{}\doxysection{Signature}\label{doc_api_review_core_keyIsDirectlyBelow_md_autotoc_md1002}
{\ttfamily int \mbox{\hyperlink{group__keytest_ga0150fb549225d8789e7297b919965e72}{key\+Is\+Directly\+Below(const Key $\ast$key, const Key $\ast$check)}}}\hypertarget{doc_api_review_core_keyIsDirectlyBelow_md_autotoc_md1003}{}\doxysection{Checklist}\label{doc_api_review_core_keyIsDirectlyBelow_md_autotoc_md1003}
\hypertarget{doc_api_review_core_keyIsDirectlyBelow_md_autotoc_md1004}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_keyIsDirectlyBelow_md_autotoc_md1004}
(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{]} split examples ~\newline

\item \mbox{[} \mbox{]} turn examples into proper code
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Longer description of function containing common use cases ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} move description from examples to documentation body
\end{DoxyItemize}
\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{]} \textquotesingle{}check is below key\textquotesingle{} -\/$&gt;$ \textquotesingle{}check is directly below key\textquotesingle{}
\end{DoxyItemize}
\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{]} split and add descriptions
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyIsDirectlyBelow_md_autotoc_md1005}{}\doxysubsection{Naming}\label{doc_api_review_core_keyIsDirectlyBelow_md_autotoc_md1005}

\begin{DoxyItemize}
\item 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 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{[} \mbox{]} Parameter names should be clear and unambiguous ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} the name of {\ttfamily check} might be improved
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyIsDirectlyBelow_md_autotoc_md1006}{}\doxysubsection{Compatibility}\label{doc_api_review_core_keyIsDirectlyBelow_md_autotoc_md1006}
(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_keyIsDirectlyBelow_md_autotoc_md1007}{}\doxysubsection{Parameter \&amp; Return Types}\label{doc_api_review_core_keyIsDirectlyBelow_md_autotoc_md1007}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} 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_keyIsDirectlyBelow_md_autotoc_md1008}{}\doxysubsection{Structural Clarity}\label{doc_api_review_core_keyIsDirectlyBelow_md_autotoc_md1008}

\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{]} swapped with {\ttfamily \mbox{\hyperlink{keytest_8c_a6250a0bad75aa9abb20a98e69ad2d299}{key\+Is\+Below\+Or\+Same()}}}
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} No functions with similar purpose exist
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyIsDirectlyBelow_md_autotoc_md1009}{}\doxysubsection{Memory Management}\label{doc_api_review_core_keyIsDirectlyBelow_md_autotoc_md1009}

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

\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_keyIsDirectlyBelow_md_autotoc_md1011}{}\doxysubsection{Tests}\label{doc_api_review_core_keyIsDirectlyBelow_md_autotoc_md1011}

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Line 293 ~\newline

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Line 293 seems to be checked ~\newline

\item \mbox{[} \mbox{]} Line 326 seems to be checked
\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_keyIsDirectlyBelow_md_autotoc_md1012}{}\doxysection{Summary}\label{doc_api_review_core_keyIsDirectlyBelow_md_autotoc_md1012}
\hypertarget{doc_api_review_core_keyIsDirectlyBelow_md_autotoc_md1013}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_keyIsDirectlyBelow_md_autotoc_md1013}

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily key\+Is\+Below\+Or\+Same} is not contained in Doxygen
\item \mbox{[} \mbox{]} maybe merge {\ttfamily key\+Below\+Family} into one function with flags 
\end{DoxyItemize}</pre></body></html>