\label{doc_contrib_api_reviews_core_ksLookup_md_md_doc_contrib_api_reviews_core_ksLookup}%
\Hypertarget{doc_contrib_api_reviews_core_ksLookup_md_md_doc_contrib_api_reviews_core_ksLookup}%

\begin{DoxyItemize}
\item start = 2021-\/03-\/14 13\+:00
\item end = 2021-\/03-\/14 13\+:20
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_ksLookup_md_autotoc_md1574}{}\doxysection{Signature}\label{doc_contrib_api_reviews_core_ksLookup_md_autotoc_md1574}
{\ttfamily Key $\ast$ks\+Lookup(Key\+Set $\ast$ks, Key $\ast$k, elektra\+Lookup\+Flags options)}\hypertarget{doc_contrib_api_reviews_core_ksLookup_md_autotoc_md1575}{}\doxysection{Checklist}\label{doc_contrib_api_reviews_core_ksLookup_md_autotoc_md1575}
\hypertarget{doc_contrib_api_reviews_core_ksLookup_md_autotoc_md1576}{}\doxysubsubsection{Doxygen}\label{doc_contrib_api_reviews_core_ksLookup_md_autotoc_md1576}
(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{[} \mbox{]} Longer description of function containing common use cases ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} only example uses {\ttfamily ks\+Lookup\+By\+Name}
\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{]} remove \textquotesingle{}0 otherwise\textquotesingle{} from {\ttfamily @return}
\end{DoxyItemize}
\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{[}x\mbox{]} {\ttfamily @see}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_ksLookup_md_autotoc_md1577}{}\doxysubsection{Naming}\label{doc_contrib_api_reviews_core_ksLookup_md_autotoc_md1577}

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} change name to {\ttfamily ks\+Lookup\+By\+Key} to fit {\ttfamily \mbox{\hyperlink{group__keyset_gad65d2cdcbb5381194a1688e169af8a83}{ks\+Lookup\+By\+Name()}}}?
\end{DoxyItemize}
\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_contrib_api_reviews_core_ksLookup_md_autotoc_md1578}{}\doxysubsection{Compatibility}\label{doc_contrib_api_reviews_core_ksLookup_md_autotoc_md1578}
(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_ksLookup_md_autotoc_md1579}{}\doxysubsection{Parameter \& Return Types}\label{doc_contrib_api_reviews_core_ksLookup_md_autotoc_md1579}

\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_contrib_api_reviews_core_ksLookup_md_autotoc_md1580}{}\doxysubsection{Structural Clarity}\label{doc_contrib_api_reviews_core_ksLookup_md_autotoc_md1580}

\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_contrib_api_reviews_core_ksLookup_md_autotoc_md1581}{}\doxysubsection{Memory Management}\label{doc_contrib_api_reviews_core_ksLookup_md_autotoc_md1581}

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

\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_ksLookup_md_autotoc_md1583}{}\doxysubsection{Tests}\label{doc_contrib_api_reviews_core_ksLookup_md_autotoc_md1583}

\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 \mbox{[} \mbox{]} All possible enum values are covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} {\ttfamily KDB\+\_\+\+O\+\_\+\+DEL}
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} No inconsistencies between tests and documentation
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_ksLookup_md_autotoc_md1584}{}\doxysection{Summary}\label{doc_contrib_api_reviews_core_ksLookup_md_autotoc_md1584}

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Maybe convert some documentation from here to snippets and reference it in {\ttfamily \mbox{\hyperlink{group__keyset_gad65d2cdcbb5381194a1688e169af8a83}{ks\+Lookup\+By\+Name()}}}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_ksLookup_md_autotoc_md1585}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_contrib_api_reviews_core_ksLookup_md_autotoc_md1585}
