\label{doc_api_review_core_kdbOpen_md_md_doc_api_review_core_kdbOpen}%
\Hypertarget{doc_api_review_core_kdbOpen_md_md_doc_api_review_core_kdbOpen}%

\begin{DoxyItemize}
\item start = 2021-\/03-\/20 18\+:55
\item end = 2021-\/03-\/20 19\+:10
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_api_review_core_kdbOpen_md_autotoc_md683}{}\doxysection{Signature}\label{doc_api_review_core_kdbOpen_md_autotoc_md683}
{\ttfamily KDB $\ast$ kdb\+Open(\+Key $\ast$error\+Key)}\hypertarget{doc_api_review_core_kdbOpen_md_autotoc_md684}{}\doxysection{Checklist}\label{doc_api_review_core_kdbOpen_md_autotoc_md684}
\hypertarget{doc_api_review_core_kdbOpen_md_autotoc_md685}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_kdbOpen_md_autotoc_md685}
(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{]} how do errors end up in {\ttfamily error\+Key}? ~\newline

\item \mbox{[} \mbox{]} what kind of errors end up in {\ttfamily error\+Key}?
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Description of functions reads nicely ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} monospace \textquotesingle{}system\+:/elektra/mountpoints\textquotesingle{} ~\newline

\item \mbox{[} \mbox{]} move \textquotesingle{}You must always call...\textquotesingle{} one paragraph up
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @pre} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} remove first (duplicated) ~\newline

\item \mbox{[} \mbox{]} move below description
\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{[} \mbox{]} {\ttfamily @param} for every parameter ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} explain format of contract
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @return} / {\ttfamily @retval} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} specify failure conditions
\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{]} remove {\ttfamily kdb\+Get}?
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_kdbOpen_md_autotoc_md686}{}\doxysubsection{Naming}\label{doc_api_review_core_kdbOpen_md_autotoc_md686}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} 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 \mbox{[}x\mbox{]} 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_kdbOpen_md_autotoc_md687}{}\doxysubsection{Compatibility}\label{doc_api_review_core_kdbOpen_md_autotoc_md687}
(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_kdbOpen_md_autotoc_md688}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_kdbOpen_md_autotoc_md688}

\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_kdbOpen_md_autotoc_md689}{}\doxysubsection{Structural Clarity}\label{doc_api_review_core_kdbOpen_md_autotoc_md689}

\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_kdbOpen_md_autotoc_md690}{}\doxysubsection{Memory Management}\label{doc_api_review_core_kdbOpen_md_autotoc_md690}

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

\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_kdbOpen_md_autotoc_md692}{}\doxysubsection{Tests}\label{doc_api_review_core_kdbOpen_md_autotoc_md692}

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Function code is fully covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Lines 433\+:443 ~\newline

\item \mbox{[} \mbox{]} Lines 451\+:470 ~\newline

\item \mbox{[} \mbox{]} Line 478 ~\newline

\item \mbox{[} \mbox{]} Lines 508\+:515 ~\newline

\item \mbox{[} \mbox{]} Lines 531\+:539 ~\newline

\item \mbox{[} \mbox{]} return value never checked in tests
\end{DoxyItemize}
\item \mbox{[} \mbox{]} All possible error states are covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily error\+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_api_review_core_kdbOpen_md_autotoc_md693}{}\doxysection{Summary}\label{doc_api_review_core_kdbOpen_md_autotoc_md693}
\hypertarget{doc_api_review_core_kdbOpen_md_autotoc_md694}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_kdbOpen_md_autotoc_md694}
{\ttfamily ks\+Rename\+Keys} and {\ttfamily elektra\+Open\+Bootstrap} in API Documentation 