\label{doc_contrib_api_reviews_core_keyGetUnescapedNameSize_md_md_doc_contrib_api_reviews_core_keyGetUnescapedNameSize}%
\Hypertarget{doc_contrib_api_reviews_core_keyGetUnescapedNameSize_md_md_doc_contrib_api_reviews_core_keyGetUnescapedNameSize}%

\begin{DoxyItemize}
\item start = 2021-\/03-\/02 22\+:00
\item end = 2021-\/03-\/02 22\+:15
\item moderator = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyGetUnescapedNameSize_md_autotoc_md1118}{}\doxysection{Signature}\label{doc_contrib_api_reviews_core_keyGetUnescapedNameSize_md_autotoc_md1118}
{\ttfamily ssize\+\_\+t \mbox{\hyperlink{group__keyname_ga5e7eff0c77678420199d0d2e8729152b}{key\+Get\+Unescaped\+Name\+Size(const Key $\ast$key)}}}\hypertarget{doc_contrib_api_reviews_core_keyGetUnescapedNameSize_md_autotoc_md1119}{}\doxysection{Checklist}\label{doc_contrib_api_reviews_core_keyGetUnescapedNameSize_md_autotoc_md1119}
\hypertarget{doc_contrib_api_reviews_core_keyGetUnescapedNameSize_md_autotoc_md1120}{}\doxysubsubsection{Doxygen}\label{doc_contrib_api_reviews_core_keyGetUnescapedNameSize_md_autotoc_md1120}
(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 \mbox{[} \mbox{]} Longer description of function containing common use cases
\item \mbox{[} \mbox{]} Description of functions reads nicely ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} return -\/$>$ Returns the size of the unescaped name, including ...
\end{DoxyItemize}
\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 @return} for base case
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @since} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @ingroup} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @see} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add {\ttfamily \mbox{\hyperlink{group__keyname_gabdbcfa51ed8a387e47ead207affa2d2e}{key\+Get\+Name\+Size()}}} ~\newline

\item \mbox{[} \mbox{]} add {\ttfamily \mbox{\hyperlink{group__keyname_ga44a576c7919d5b03f28d3ed3afaa7cd1}{key\+Get\+Unescaped\+Name()}}}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyGetUnescapedNameSize_md_autotoc_md1121}{}\doxysubsection{Naming}\label{doc_contrib_api_reviews_core_keyGetUnescapedNameSize_md_autotoc_md1121}

\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_keyGetUnescapedNameSize_md_autotoc_md1122}{}\doxysubsection{Compatibility}\label{doc_contrib_api_reviews_core_keyGetUnescapedNameSize_md_autotoc_md1122}
(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_keyGetUnescapedNameSize_md_autotoc_md1123}{}\doxysubsection{Parameter \& Return Types}\label{doc_contrib_api_reviews_core_keyGetUnescapedNameSize_md_autotoc_md1123}

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

\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{]} Order is mixed up, needs to be lower in Doxygen
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} No functions with similar purpose exist
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyGetUnescapedNameSize_md_autotoc_md1125}{}\doxysubsection{Memory Management}\label{doc_contrib_api_reviews_core_keyGetUnescapedNameSize_md_autotoc_md1125}

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

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

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

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} no explicit calls in tests suite
\end{DoxyItemize}
\item \mbox{[} \mbox{]} All possible error states are covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} no explicit calls in tests suite
\end{DoxyItemize}
\item All possible enum values are covered by tests
\item \mbox{[} \mbox{]} No inconsistencies between tests and documentation ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} no explicit calls in tests suite
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keyGetUnescapedNameSize_md_autotoc_md1128}{}\doxysection{Summary}\label{doc_contrib_api_reviews_core_keyGetUnescapedNameSize_md_autotoc_md1128}
\hypertarget{doc_contrib_api_reviews_core_keyGetUnescapedNameSize_md_autotoc_md1129}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_contrib_api_reviews_core_keyGetUnescapedNameSize_md_autotoc_md1129}
