\label{doc_contrib_api_reviews_core_keyValue_md_md_doc_contrib_api_reviews_core_keyValue}%
\Hypertarget{doc_contrib_api_reviews_core_keyValue_md_md_doc_contrib_api_reviews_core_keyValue}%

\begin{DoxyItemize}
\item start = 2021-\/03-\/20 18\+:45
\item end = 2021-\/03-\/20 18\+:55
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyValue_md_autotoc_md1406}{}\doxysection{Signature}\label{doc_contrib_api_reviews_core_keyValue_md_autotoc_md1406}
{\ttfamily const void $\ast$key\+Value(const Key $\ast$key)}\hypertarget{doc_contrib_api_reviews_core_keyValue_md_autotoc_md1407}{}\doxysection{Checklist}\label{doc_contrib_api_reviews_core_keyValue_md_autotoc_md1407}
\hypertarget{doc_contrib_api_reviews_core_keyValue_md_autotoc_md1408}{}\doxysubsubsection{Doxygen}\label{doc_contrib_api_reviews_core_keyValue_md_autotoc_md1408}
(bullet points are in order of appearance)


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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} use correct testing functions in examples
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Description of functions reads nicely ~\newline

\begin{DoxyItemize}
\item \textquotesingle{}and you should use it if\textquotesingle{} -\/$>$ \textquotesingle{}and you should use it, if\textquotesingle{}
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @pre} ~\newline

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

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

\begin{DoxyItemize}
\item \mbox{[}x\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{]} split first line and add explanations ~\newline

\item \mbox{[} \mbox{]} add {\ttfamily \mbox{\hyperlink{group__keytest_ga9526b371087564e43e3dff8ad0dac949}{key\+Is\+Binary()}}} ~\newline

\item \mbox{[} \mbox{]} add {\ttfamily \mbox{\hyperlink{group__keytest_gaea7670778abd07fee0fe8ac12a149190}{key\+Is\+String()}}}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyValue_md_autotoc_md1409}{}\doxysubsection{Naming}\label{doc_contrib_api_reviews_core_keyValue_md_autotoc_md1409}

\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{[}x\mbox{]} Parameter names should be clear and unambiguous
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyValue_md_autotoc_md1410}{}\doxysubsection{Compatibility}\label{doc_contrib_api_reviews_core_keyValue_md_autotoc_md1410}
(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_contrib_api_reviews_core_keyValue_md_autotoc_md1411}{}\doxysubsection{Parameter \& Return Types}\label{doc_contrib_api_reviews_core_keyValue_md_autotoc_md1411}

\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_contrib_api_reviews_core_keyValue_md_autotoc_md1412}{}\doxysubsection{Structural Clarity}\label{doc_contrib_api_reviews_core_keyValue_md_autotoc_md1412}

\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_contrib_api_reviews_core_keyValue_md_autotoc_md1413}{}\doxysubsection{Memory Management}\label{doc_contrib_api_reviews_core_keyValue_md_autotoc_md1413}

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

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Function is easily extensible, e.\+g., with flags
\item \mbox{[} \mbox{]} Documentation does not impose limits, that would hinder further extensions ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} return type on empty string/ binary?
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyValue_md_autotoc_md1415}{}\doxysubsection{Tests}\label{doc_contrib_api_reviews_core_keyValue_md_autotoc_md1415}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Function code is fully covered by tests
\item \mbox{[}x\mbox{]} All possible error states are covered by tests
\item All possible enum values are covered by tests
\item \mbox{[}x\mbox{]} No inconsistencies between tests and documentation
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyValue_md_autotoc_md1416}{}\doxysection{Summary}\label{doc_contrib_api_reviews_core_keyValue_md_autotoc_md1416}
\hypertarget{doc_contrib_api_reviews_core_keyValue_md_autotoc_md1417}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_contrib_api_reviews_core_keyValue_md_autotoc_md1417}
