
\begin{DoxyItemize}
\item start = 2021-\/02-\/21 12\+:20
\item end = 2021-\/02-\/21 18\+:10
\item moderator = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\tt stefanhani@gmail.\+com}
\item reviewer = Dominic Jäger
\end{DoxyItemize}

{\ttfamily ssize\+\_\+t \hyperlink{group__keyvalue_ga622bde1eb0e0c4994728331326340ef2}{key\+Set\+String(\+Key $\ast$key, const char $\ast$new\+String)}}

(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
\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item Longer description of function containing common use cases
\begin{DoxyItemize}
\item All uses cases covered by brief description
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Description of functions reads nicely
\begin{DoxyItemize}
\item \mbox{[} \mbox{]} \textquotesingle{}as new string value\textquotesingle{} seems strange
\item \mbox{[} \mbox{]} \textquotesingle{}private copy\textquotesingle{} is unclear
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @pre}
\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @post}
\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\item \mbox{[} \mbox{]} string saved as U\+T\+F-\/8 in backend
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @invariant}
\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @param} for every parameter
\begin{DoxyItemize}
\item \mbox{[} \mbox{]} \textquotesingle{}text string\textquotesingle{} maybe redundant?
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} {\ttfamily @return} / {\ttfamily @retval}
\item \mbox{[} \mbox{]} {\ttfamily @since}
\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} `{\ttfamily }
\item {\ttfamily \mbox{[} \mbox{]}}\begin{DoxySeeAlso}{See also}
`
\begin{DoxyItemize}
\item \mbox{[} \mbox{]} split to multiple lines
\item \mbox{[} \mbox{]} shortly explain differences between {\ttfamily \hyperlink{group__keyvalue_ga880936f2481d28e6e2acbe7486a21d05}{key\+String}} {\ttfamily \hyperlink{group__keyvalue_ga41b9fac5ccddafe407fc0ae1e2eb8778}{key\+Get\+String}}
\item \mbox{[} \mbox{]} add {\ttfamily \hyperlink{group__keyvalue_gaa50a5358fd328d373a45f395fa1b99e7}{key\+Set\+Binary}} ?
\item \mbox{[} \mbox{]} remove {\ttfamily \hyperlink{group__keyvalue_ga6f29609c5da53c6dc26a98678d5752af}{key\+Value}}, as it is not related to string
\end{DoxyItemize}
\end{DoxySeeAlso}

\end{DoxyItemize}


\begin{DoxyItemize}
\item Abbreviations used in function names must be defined in the \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 \hyperlink{doc_help_elektra-glossary_md}{Glossary}
\item \mbox{[} \mbox{]} Parameter names should neither be too long, nor too short
\begin{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily new\+String\+Value} -\/ remove Value?
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Parameter names should be clear and unambiguous
\end{DoxyItemize}

(only in P\+Rs)


\begin{DoxyItemize}
\item \hyperlink{doc_dev_symbol-versioning_md}{Symbol versioning} is correct for breaking changes
\item A\+B\+I/\+A\+PI changes are forward-\/compatible (breaking backwards-\/compatibility to add additional symbols is fine)
\end{DoxyItemize}


\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}


\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}


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


\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Function is easily extensible, e.\+g., with flags
\item \mbox{[} \mbox{]} Documentation does not impose limits, that would hinder further extensions
\begin{DoxyItemize}
\item \mbox{[} \mbox{]} iconv-\/\+Plugin
\item \mbox{[} \mbox{]} U\+T\+F-\/8
\item \mbox{[} \mbox{]} Return Value on N\+U\+LL
\end{DoxyItemize}
\end{DoxyItemize}


\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 All possible enum values are covered by tests
\item \mbox{[}x\mbox{]} No inconsistencies between tests and documentation
\end{DoxyItemize}

Behavior when {\ttfamily new\+String\+Value} is a N\+U\+LL pointer seems strange

Exact difference key\+String key\+Get\+String ? 