\label{doc_contrib_api_reviews_core_keySetBaseName_md_md_doc_contrib_api_reviews_core_keySetBaseName}%
\Hypertarget{doc_contrib_api_reviews_core_keySetBaseName_md_md_doc_contrib_api_reviews_core_keySetBaseName}%

\begin{DoxyItemize}
\item start = 2021-\/03-\/04 22\+:00
\item end = 2021-\/03-\/04 22\+:35
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keySetBaseName_md_autotoc_md1310}{}\doxysection{Signature}\label{doc_contrib_api_reviews_core_keySetBaseName_md_autotoc_md1310}
{\ttfamily ssize\+\_\+t \mbox{\hyperlink{group__keyname_ga6e804bd453f98c28b0ff51430d1df407}{key\+Set\+Base\+Name(\+Key $\ast$key,const char $\ast$base\+Name)}}}\hypertarget{doc_contrib_api_reviews_core_keySetBaseName_md_autotoc_md1311}{}\doxysection{Checklist}\label{doc_contrib_api_reviews_core_keySetBaseName_md_autotoc_md1311}
\hypertarget{doc_contrib_api_reviews_core_keySetBaseName_md_autotoc_md1312}{}\doxysubsubsection{Doxygen}\label{doc_contrib_api_reviews_core_keySetBaseName_md_autotoc_md1312}
(bullet points are in order of appearance)


\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} First line explains briefly what the function does
\item \mbox{[}x\mbox{]} Simple example or snippet how to use the function
\item \mbox{[} \mbox{]} Longer description of function containing common use cases ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add notice for read-\/only ~\newline

\item \mbox{[} \mbox{]} add notice that root-\/name can\textquotesingle{}t be removed
\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{]} add {\ttfamily @retval} for read-\/only
\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{]} remove first {\ttfamily @see} and merge description into the parts below
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keySetBaseName_md_autotoc_md1313}{}\doxysubsection{Naming}\label{doc_contrib_api_reviews_core_keySetBaseName_md_autotoc_md1313}

\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_keySetBaseName_md_autotoc_md1314}{}\doxysubsection{Compatibility}\label{doc_contrib_api_reviews_core_keySetBaseName_md_autotoc_md1314}
(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_keySetBaseName_md_autotoc_md1315}{}\doxysubsection{Parameter \& Return Types}\label{doc_contrib_api_reviews_core_keySetBaseName_md_autotoc_md1315}

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

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Functions should do exactly one thing
\item \mbox{[}x\mbox{]} Function name has the appropriate prefix
\item \mbox{[} \mbox{]} Order of signatures in kdb.\+h.\+in is the same as Doxygen ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} swapped with {\ttfamily \mbox{\hyperlink{group__keyname_gaa942091fc4bd5c2699e49ddc50829524}{key\+Add\+Base\+Name()}}}
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} No functions with similar purpose exist
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keySetBaseName_md_autotoc_md1317}{}\doxysubsection{Memory Management}\label{doc_contrib_api_reviews_core_keySetBaseName_md_autotoc_md1317}

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

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

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

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Line 1475
\end{DoxyItemize}
\item \mbox{[} \mbox{]} All possible error states are covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} {\ttfamily base\+Name\+Ptr == NULL} ~\newline

\item \mbox{[}x\mbox{]} {\ttfamily key == NULL} ~\newline

\item \mbox{[}x\mbox{]} key is read-\/only
\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_keySetBaseName_md_autotoc_md1320}{}\doxysection{Summary}\label{doc_contrib_api_reviews_core_keySetBaseName_md_autotoc_md1320}
\hypertarget{doc_contrib_api_reviews_core_keySetBaseName_md_autotoc_md1321}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_contrib_api_reviews_core_keySetBaseName_md_autotoc_md1321}
