\label{doc_api_review_core_ksNeedSync_md_md_doc_api_review_core_ksNeedSync}%
\Hypertarget{doc_api_review_core_ksNeedSync_md_md_doc_api_review_core_ksNeedSync}%

\begin{DoxyItemize}
\item start = 2021-\/03-\/20 16\+:55
\item end = 2021-\/03-\/20 17\+:20
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksNeedSync_md_autotoc_md1429}{}\doxysection{Signature}\label{doc_api_review_core_ksNeedSync_md_autotoc_md1429}
{\ttfamily int ks\+Need\+Sync(const Key\+Set $\ast$ks)}\hypertarget{doc_api_review_core_ksNeedSync_md_autotoc_md1430}{}\doxysection{Checklist}\label{doc_api_review_core_ksNeedSync_md_autotoc_md1430}
\hypertarget{doc_api_review_core_ksNeedSync_md_autotoc_md1431}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_ksNeedSync_md_autotoc_md1431}
(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{[}x\mbox{]} {\ttfamily @return} / {\ttfamily @retval}
\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{]} add {\ttfamily \mbox{\hyperlink{group__keytest_gaf247df0de7aca04b32ef80e39ef12950}{key\+Need\+Sync()}}}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksNeedSync_md_autotoc_md1432}{}\doxysubsection{Naming}\label{doc_api_review_core_ksNeedSync_md_autotoc_md1432}

\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{[} \mbox{]} Parameter names should neither be too long, nor too short ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily ks} -\/$>$ {\ttfamily key\+Set}
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Parameter names should be clear and unambiguous
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksNeedSync_md_autotoc_md1433}{}\doxysubsection{Compatibility}\label{doc_api_review_core_ksNeedSync_md_autotoc_md1433}
(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_ksNeedSync_md_autotoc_md1434}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_ksNeedSync_md_autotoc_md1434}

\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_ksNeedSync_md_autotoc_md1435}{}\doxysubsection{Structural Clarity}\label{doc_api_review_core_ksNeedSync_md_autotoc_md1435}

\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
\item \mbox{[}x\mbox{]} No functions with similar purpose exist
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksNeedSync_md_autotoc_md1436}{}\doxysubsection{Memory Management}\label{doc_api_review_core_ksNeedSync_md_autotoc_md1436}

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

\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_ksNeedSync_md_autotoc_md1438}{}\doxysubsection{Tests}\label{doc_api_review_core_ksNeedSync_md_autotoc_md1438}

\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{[} \mbox{]} add test case for {\ttfamily ks == 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_api_review_core_ksNeedSync_md_autotoc_md1439}{}\doxysection{Summary}\label{doc_api_review_core_ksNeedSync_md_autotoc_md1439}
\hypertarget{doc_api_review_core_ksNeedSync_md_autotoc_md1440}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_ksNeedSync_md_autotoc_md1440}
