\label{doc_api_review_core_keyMeta_md_md_doc_api_review_core_keyMeta}%
\Hypertarget{doc_api_review_core_keyMeta_md_md_doc_api_review_core_keyMeta}%

\begin{DoxyItemize}
\item start = 2021-\/01-\/23 18\+:05
\item end = 2021-\/01-\/23 18\+:20
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyMeta_md_autotoc_md1079}{}\doxysection{Signature}\label{doc_api_review_core_keyMeta_md_autotoc_md1079}
{\ttfamily Key\+Set $\ast$ key\+Meta (Key $\ast$ key)}\hypertarget{doc_api_review_core_keyMeta_md_autotoc_md1080}{}\doxysection{Checklist}\label{doc_api_review_core_keyMeta_md_autotoc_md1080}
\hypertarget{doc_api_review_core_keyMeta_md_autotoc_md1081}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_keyMeta_md_autotoc_md1081}
(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{]} keyset -\/$>$ Key\+Set
\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{]} what happens if metadata is read-\/only?
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Description of functions reads nicely
\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{[} \mbox{]} {\ttfamily @return} / {\ttfamily @retval} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} move {\ttfamily @return} above {\ttfamily @retval} ~\newline

\item \mbox{[} \mbox{]} add {\ttfamily @retval} 0 if key has no metadata
\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 into two lines
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyMeta_md_autotoc_md1082}{}\doxysubsection{Naming}\label{doc_api_review_core_keyMeta_md_autotoc_md1082}

\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_api_review_core_keyMeta_md_autotoc_md1083}{}\doxysubsection{Compatibility}\label{doc_api_review_core_keyMeta_md_autotoc_md1083}
(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_keyMeta_md_autotoc_md1084}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_keyMeta_md_autotoc_md1084}

\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{]} could key be const here? it doesn\textquotesingle{}t get modified per se
\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_keyMeta_md_autotoc_md1085}{}\doxysubsection{Structural Clarity}\label{doc_api_review_core_keyMeta_md_autotoc_md1085}

\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_keyMeta_md_autotoc_md1086}{}\doxysubsection{Memory Management}\label{doc_api_review_core_keyMeta_md_autotoc_md1086}

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

\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_keyMeta_md_autotoc_md1088}{}\doxysubsection{Tests}\label{doc_api_review_core_keyMeta_md_autotoc_md1088}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Function code is fully covered by tests
\item \mbox{[} \mbox{]} All possible error states are covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} add check if key is NULL ~\newline

\item \mbox{[}x\mbox{]} add check if key has no metadata ~\newline

\item \mbox{[}x\mbox{]} add test if metadata is read-\/only
\end{DoxyItemize}
\item All possible enum values are covered by tests
\item \mbox{[} \mbox{]} No inconsistencies between tests and documentation
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyMeta_md_autotoc_md1089}{}\doxysection{Summary}\label{doc_api_review_core_keyMeta_md_autotoc_md1089}
Should this function work if metadata of Key is set to read-\/only?\hypertarget{doc_api_review_core_keyMeta_md_autotoc_md1090}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_keyMeta_md_autotoc_md1090}
