\label{doc_contrib_api_reviews_core_keyGetString_md_md_doc_contrib_api_reviews_core_keyGetString}%
\Hypertarget{doc_contrib_api_reviews_core_keyGetString_md_md_doc_contrib_api_reviews_core_keyGetString}%

\begin{DoxyItemize}
\item start = 2021-\/03-\/06 16\+:25
\item end = 2021-\/03-\/06 16\+:40
\item moderator = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyGetString_md_autotoc_md1106}{}\doxysection{Signature}\label{doc_contrib_api_reviews_core_keyGetString_md_autotoc_md1106}
{\ttfamily ssize\+\_\+t \mbox{\hyperlink{group__keyvalue_ga41b9fac5ccddafe407fc0ae1e2eb8778}{key\+Get\+String(const Key $\ast$key, char $\ast$returned\+String, size\+\_\+t max\+Size)}}}\hypertarget{doc_contrib_api_reviews_core_keyGetString_md_autotoc_md1107}{}\doxysection{Checklist}\label{doc_contrib_api_reviews_core_keyGetString_md_autotoc_md1107}
\hypertarget{doc_contrib_api_reviews_core_keyGetString_md_autotoc_md1108}{}\doxysubsubsection{Doxygen}\label{doc_contrib_api_reviews_core_keyGetString_md_autotoc_md1108}
(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{]} Copies the string value of a Key into a provided buffer
\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{]} move binary functions to {\ttfamily @see}
\end{DoxyItemize}
\item \mbox{[} \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{]} merge 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 and add description
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyGetString_md_autotoc_md1109}{}\doxysubsection{Naming}\label{doc_contrib_api_reviews_core_keyGetString_md_autotoc_md1109}

\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_keyGetString_md_autotoc_md1110}{}\doxysubsection{Compatibility}\label{doc_contrib_api_reviews_core_keyGetString_md_autotoc_md1110}
(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_keyGetString_md_autotoc_md1111}{}\doxysubsection{Parameter \& Return Types}\label{doc_contrib_api_reviews_core_keyGetString_md_autotoc_md1111}

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

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

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

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

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

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Line 306 ~\newline

\item \mbox{[}x\mbox{]} Line 317 ~\newline
 (impossible to check -\/ overflow)
\end{DoxyItemize}
\item \mbox{[} \mbox{]} All possible error states are covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} check return value for binary strings ~\newline
 (seems to already happen? tests/abi/testabi\+\_\+key.\+c\+:1007 ff.) ~\newline

\item \mbox{[}x\mbox{]} check return value for max\+Size too small ~\newline
 (seems to already happen? tests/abi/testabi\+\_\+key.\+c\+:913) ~\newline

\item \mbox{[}x\mbox{]} check return value for max\+Size $>$ SSIZE\+\_\+\+MAX ~\newline
 (impossible to check -\/ overflow)
\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_keyGetString_md_autotoc_md1116}{}\doxysection{Summary}\label{doc_contrib_api_reviews_core_keyGetString_md_autotoc_md1116}
\hypertarget{doc_contrib_api_reviews_core_keyGetString_md_autotoc_md1117}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_contrib_api_reviews_core_keyGetString_md_autotoc_md1117}

\begin{DoxyItemize}
\item Find a different term for functions that get a pointer and functions that
\item return in to a buffer? 
\end{DoxyItemize}