\label{doc_api_review_core_keySetString_md_md_doc_api_review_core_keySetString}%
\Hypertarget{doc_api_review_core_keySetString_md_md_doc_api_review_core_keySetString}%

\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}{\texttt{ stefanhani@gmail.\+com}}
\item reviewer = Dominic Jäger
\end{DoxyItemize}\hypertarget{doc_api_review_core_keySetString_md_autotoc_md1223}{}\doxysection{Signature}\label{doc_api_review_core_keySetString_md_autotoc_md1223}
{\ttfamily ssize\+\_\+t \mbox{\hyperlink{group__keyvalue_ga622bde1eb0e0c4994728331326340ef2}{key\+Set\+String(\+Key $\ast$key, const char $\ast$new\+String)}}}\hypertarget{doc_api_review_core_keySetString_md_autotoc_md1224}{}\doxysection{Checklist}\label{doc_api_review_core_keySetString_md_autotoc_md1224}
\hypertarget{doc_api_review_core_keySetString_md_autotoc_md1225}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_keySetString_md_autotoc_md1225}
(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 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 ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} \textquotesingle{}as new string value\textquotesingle{} seems strange ~\newline

\item \mbox{[} \mbox{]} \textquotesingle{}private copy\textquotesingle{} is unclear
\end{DoxyItemize}
\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 ~\newline

\item \mbox{[}x\mbox{]} string saved as UTF-\/8 in backend
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @invariant} ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} add
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @param} for every parameter ~\newline

\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} ~\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 to multiple lines ~\newline

\item \mbox{[} \mbox{]} shortly explain differences between {\ttfamily key\+String} {\ttfamily key\+Get\+String} ~\newline

\item \mbox{[} \mbox{]} add {\ttfamily key\+Set\+Binary} ? ~\newline

\item \mbox{[} \mbox{]} remove {\ttfamily key\+Value}, as it is not related to string
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keySetString_md_autotoc_md1226}{}\doxysubsection{Naming}\label{doc_api_review_core_keySetString_md_autotoc_md1226}

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

\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}\hypertarget{doc_api_review_core_keySetString_md_autotoc_md1227}{}\doxysubsection{Compatibility}\label{doc_api_review_core_keySetString_md_autotoc_md1227}
(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_keySetString_md_autotoc_md1228}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_keySetString_md_autotoc_md1228}

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

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

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

\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 ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} iconv-\/\+Plugin ~\newline

\item \mbox{[} \mbox{]} UTF-\/8 ~\newline

\item \mbox{[} \mbox{]} Return Value on NULL
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keySetString_md_autotoc_md1232}{}\doxysubsection{Tests}\label{doc_api_review_core_keySetString_md_autotoc_md1232}

\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}\hypertarget{doc_api_review_core_keySetString_md_autotoc_md1233}{}\doxysection{Summary}\label{doc_api_review_core_keySetString_md_autotoc_md1233}
Behavior when {\ttfamily new\+String\+Value} is a NULL pointer seems strange\hypertarget{doc_api_review_core_keySetString_md_autotoc_md1234}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_keySetString_md_autotoc_md1234}
Exact difference key\+String key\+Get\+String ? 