\label{doc_api_review_core_keyGetNamespace_md_md_doc_api_review_core_keyGetNamespace}%
\Hypertarget{doc_api_review_core_keyGetNamespace_md_md_doc_api_review_core_keyGetNamespace}%

\begin{DoxyItemize}
\item start = 2021-\/03-\/04 22\+:40
\item end = 2021-\/03-\/04 22\+:50
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyGetNamespace_md_autotoc_md908}{}\doxysection{Signature}\label{doc_api_review_core_keyGetNamespace_md_autotoc_md908}
{\ttfamily elektra\+Namespace \mbox{\hyperlink{group__keyname_gafc3ca03ed10f87eb59bdc02cf2a0de8d}{key\+Get\+Namespace(\+Key const$\ast$ key)}}}\hypertarget{doc_api_review_core_keyGetNamespace_md_autotoc_md909}{}\doxysection{Checklist}\label{doc_api_review_core_keyGetNamespace_md_autotoc_md909}
\hypertarget{doc_api_review_core_keyGetNamespace_md_autotoc_md910}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_keyGetNamespace_md_autotoc_md910}
(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{]} add \textquotesingle{}returns the {\ttfamily elektra\+Namespace} for a given key\textquotesingle{}
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Simple example or snippet how to use the function
\item \mbox{[}x\mbox{]} Longer description of function containing common use cases
\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 key == {\ttfamily NULL} ?
\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{]} add {\ttfamily \mbox{\hyperlink{group__keyname_ga98c1c1307419e689c98e556e5c542073}{key\+Set\+Namespace()}}}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyGetNamespace_md_autotoc_md911}{}\doxysubsection{Naming}\label{doc_api_review_core_keyGetNamespace_md_autotoc_md911}

\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_api_review_core_keyGetNamespace_md_autotoc_md912}{}\doxysubsection{Compatibility}\label{doc_api_review_core_keyGetNamespace_md_autotoc_md912}
(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_keyGetNamespace_md_autotoc_md913}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_keyGetNamespace_md_autotoc_md913}

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} 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_keyGetNamespace_md_autotoc_md914}{}\doxysubsection{Structural Clarity}\label{doc_api_review_core_keyGetNamespace_md_autotoc_md914}

\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_keyGetNamespace_md_autotoc_md915}{}\doxysubsection{Memory Management}\label{doc_api_review_core_keyGetNamespace_md_autotoc_md915}

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

\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_api_review_core_keyGetNamespace_md_autotoc_md917}{}\doxysubsection{Tests}\label{doc_api_review_core_keyGetNamespace_md_autotoc_md917}

\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 \mbox{[} \mbox{]} All possible enum values are covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} {\ttfamily KEY\+\_\+\+NS\+\_\+\+META} ~\newline

\item \mbox{[}x\mbox{]} {\ttfamily KEY\+\_\+\+NS\+\_\+\+PROC} ~\newline

\item \mbox{[}x\mbox{]} {\ttfamily KEY\+\_\+\+NS\+\_\+\+DIR} ~\newline

\item \mbox{[}x\mbox{]} {\ttfamily KEY\+\_\+\+NS\+\_\+\+DEFAULT}
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} No inconsistencies between tests and documentation
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyGetNamespace_md_autotoc_md918}{}\doxysection{Summary}\label{doc_api_review_core_keyGetNamespace_md_autotoc_md918}
\hypertarget{doc_api_review_core_keyGetNamespace_md_autotoc_md919}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_keyGetNamespace_md_autotoc_md919}
