\label{doc_contrib_api_reviews_core_keyNeedSync_md_md_doc_contrib_api_reviews_core_keyNeedSync}%
\Hypertarget{doc_contrib_api_reviews_core_keyNeedSync_md_md_doc_contrib_api_reviews_core_keyNeedSync}%

\begin{DoxyItemize}
\item start = 2021-\/03-\/07 18\+:05
\item end = 2021-\/03-\/07 18\+:15
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyNeedSync_md_autotoc_md1241}{}\doxysection{Signature}\label{doc_contrib_api_reviews_core_keyNeedSync_md_autotoc_md1241}
{\ttfamily int \mbox{\hyperlink{group__keytest_gaf247df0de7aca04b32ef80e39ef12950}{key\+Need\+Sync(const Key $\ast$key)}}}\hypertarget{doc_contrib_api_reviews_core_keyNeedSync_md_autotoc_md1242}{}\doxysection{Checklist}\label{doc_contrib_api_reviews_core_keyNeedSync_md_autotoc_md1242}
\hypertarget{doc_contrib_api_reviews_core_keyNeedSync_md_autotoc_md1243}{}\doxysubsubsection{Doxygen}\label{doc_contrib_api_reviews_core_keyNeedSync_md_autotoc_md1243}
(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{[}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{]} split first line into two lines
\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 ~\newline

\item \mbox{[} \mbox{]} move to bottom
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyNeedSync_md_autotoc_md1244}{}\doxysubsection{Naming}\label{doc_contrib_api_reviews_core_keyNeedSync_md_autotoc_md1244}

\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_keyNeedSync_md_autotoc_md1245}{}\doxysubsection{Compatibility}\label{doc_contrib_api_reviews_core_keyNeedSync_md_autotoc_md1245}
(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_keyNeedSync_md_autotoc_md1246}{}\doxysubsection{Parameter \& Return Types}\label{doc_contrib_api_reviews_core_keyNeedSync_md_autotoc_md1246}

\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_keyNeedSync_md_autotoc_md1247}{}\doxysubsection{Structural Clarity}\label{doc_contrib_api_reviews_core_keyNeedSync_md_autotoc_md1247}

\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_keyNeedSync_md_autotoc_md1248}{}\doxysubsection{Memory Management}\label{doc_contrib_api_reviews_core_keyNeedSync_md_autotoc_md1248}

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

\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_contrib_api_reviews_core_keyNeedSync_md_autotoc_md1250}{}\doxysubsection{Tests}\label{doc_contrib_api_reviews_core_keyNeedSync_md_autotoc_md1250}

\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 test for {\ttfamily key == NULL}
\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_contrib_api_reviews_core_keyNeedSync_md_autotoc_md1251}{}\doxysection{Summary}\label{doc_contrib_api_reviews_core_keyNeedSync_md_autotoc_md1251}
\hypertarget{doc_contrib_api_reviews_core_keyNeedSync_md_autotoc_md1252}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_contrib_api_reviews_core_keyNeedSync_md_autotoc_md1252}
