
\begin{DoxyItemize}
\item start = 2021-\/03-\/07 17\+:15
\item end = 2021-\/03-\/07 17\+:30
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_keyGetBinary_autotoc_md871}{}\doxysection{Signature}\label{md_doc_api_review_core_keyGetBinary_autotoc_md871}
{\ttfamily ssize\+\_\+t \mbox{\hyperlink{group__keyvalue_ga4c0d8a4a11174197699c231e0b5c3c84}{key\+Get\+Binary(const Key $\ast$key, void $\ast$returned\+Binary, size\+\_\+t max\+Size)}}}\hypertarget{md_doc_api_review_core_keyGetBinary_autotoc_md872}{}\doxysection{Checklist}\label{md_doc_api_review_core_keyGetBinary_autotoc_md872}
\hypertarget{md_doc_api_review_core_keyGetBinary_autotoc_md873}{}\doxysubsubsection{Doxygen}\label{md_doc_api_review_core_keyGetBinary_autotoc_md873}
(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{]} as binary data
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Simple example or snippet how to use the function ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} move up
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Longer description of function containing common use cases ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} merge reference to string functions with {\ttfamily @see} ~\newline

\item \mbox{[} \mbox{]} how exactly is empty defined for binary?
\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{]} merge lines for max\+Size errors
\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 first line
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_keyGetBinary_autotoc_md874}{}\doxysubsection{Naming}\label{md_doc_api_review_core_keyGetBinary_autotoc_md874}

\begin{DoxyItemize}
\item Abbreviations used in function names must be defined in the 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 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{md_doc_api_review_core_keyGetBinary_autotoc_md875}{}\doxysubsection{Compatibility}\label{md_doc_api_review_core_keyGetBinary_autotoc_md875}
(only in PRs)


\begin{DoxyItemize}
\item 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{md_doc_api_review_core_keyGetBinary_autotoc_md876}{}\doxysubsection{Parameter \& Return Types}\label{md_doc_api_review_core_keyGetBinary_autotoc_md876}

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

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

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

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

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} L417 ~\newline

\item \mbox{[} \mbox{]} L422 ~\newline

\item \mbox{[} \mbox{]} L427
\end{DoxyItemize}
\item \mbox{[} \mbox{]} All possible error states are covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add test for key with string value ~\newline

\item \mbox{[} \mbox{]} L422 seems to be in the tests -\/ check ~\newline

\item \mbox{[} \mbox{]} L427 seems to be in the tests -\/ check
\end{DoxyItemize}
\item All possible enum values are covered by tests
\item \mbox{[}x\mbox{]} No inconsistencies between tests and documentation
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_keyGetBinary_autotoc_md881}{}\doxysection{Summary}\label{md_doc_api_review_core_keyGetBinary_autotoc_md881}
\char`\"{}\+Clear\char`\"{} binary array on error, to mirror behavior from string? What to fill it with, though? Zeroes?\hypertarget{md_doc_api_review_core_keyGetBinary_autotoc_md882}{}\doxysection{Other Issues discovered (unrelated to function)}\label{md_doc_api_review_core_keyGetBinary_autotoc_md882}
