\label{doc_api_review_core_keyGetMeta_md_md_doc_api_review_core_keyGetMeta}%
\Hypertarget{doc_api_review_core_keyGetMeta_md_md_doc_api_review_core_keyGetMeta}%

\begin{DoxyItemize}
\item start = 2021-\/02-\/26 14\+:20
\item end = 2021-\/02-\/26 14\+:45
\item moderator = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyGetMeta_md_autotoc_md887}{}\doxysection{Signature}\label{doc_api_review_core_keyGetMeta_md_autotoc_md887}
{\ttfamily const Key $\ast$key\+Get\+Meta(const Key $\ast$key, const char$\ast$ meta\+Name)}\hypertarget{doc_api_review_core_keyGetMeta_md_autotoc_md888}{}\doxysection{Checklist}\label{doc_api_review_core_keyGetMeta_md_autotoc_md888}
\hypertarget{doc_api_review_core_keyGetMeta_md_autotoc_md889}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_keyGetMeta_md_autotoc_md889}
(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{]} returns the Key of a meta... ~\newline

\item \mbox{[} \mbox{]} name -\/$>$ meta\+Name
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Simple example or snippet how to use the function ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} move up ~\newline

\item \mbox{[} \mbox{]} assign to variable ~\newline

\item \mbox{[} \mbox{]} add comment about value in variable ~\newline

\item \mbox{[} \mbox{]} remove function, if
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Longer description of function containing common use cases
\item \mbox{[} \mbox{]} Description of functions reads nicely ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Remove \textquotesingle{}You are not allowed....\textquotesingle{}
\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
\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{]} split to two lines ~\newline

\item \mbox{[} \mbox{]} add dot after first sentence
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @return} / {\ttfamily @retval} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} move {\ttfamily @return} up ~\newline

\item \mbox{[} \mbox{]} {\ttfamily @return}\+: value -\/$>$ Key ~\newline

\item \mbox{[} \mbox{]} {\ttfamily @retval} 0 meta\+Name invalid
\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__keymeta_ga11706f1753e67933f7cffc5c0345cd29}{key\+Meta()}}}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyGetMeta_md_autotoc_md890}{}\doxysubsection{Naming}\label{doc_api_review_core_keyGetMeta_md_autotoc_md890}

\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_keyGetMeta_md_autotoc_md891}{}\doxysubsection{Compatibility}\label{doc_api_review_core_keyGetMeta_md_autotoc_md891}
(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_keyGetMeta_md_autotoc_md892}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_keyGetMeta_md_autotoc_md892}

\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_keyGetMeta_md_autotoc_md893}{}\doxysubsection{Structural Clarity}\label{doc_api_review_core_keyGetMeta_md_autotoc_md893}

\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{[} \mbox{]} No functions with similar purpose exist ~\newline
 Similar thing could be achieved via ~\newline
 {\ttfamily ks\+Lookup\+By\+Name (key\+Meta (key), meta\+Name, 0)}
\end{DoxyItemize}\hypertarget{doc_api_review_core_keyGetMeta_md_autotoc_md894}{}\doxysubsection{Memory Management}\label{doc_api_review_core_keyGetMeta_md_autotoc_md894}

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

\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_keyGetMeta_md_autotoc_md896}{}\doxysubsection{Tests}\label{doc_api_review_core_keyGetMeta_md_autotoc_md896}

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

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

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} key is 0 ~\newline

\item \mbox{[}x\mbox{]} meta\+Name is 0
\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_api_review_core_keyGetMeta_md_autotoc_md897}{}\doxysection{Summary}\label{doc_api_review_core_keyGetMeta_md_autotoc_md897}
\hypertarget{doc_api_review_core_keyGetMeta_md_autotoc_md898}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_keyGetMeta_md_autotoc_md898}
