\label{doc_contrib_api_reviews_core_keySetMeta_md_md_doc_contrib_api_reviews_core_keySetMeta}%
\Hypertarget{doc_contrib_api_reviews_core_keySetMeta_md_md_doc_contrib_api_reviews_core_keySetMeta}%

\begin{DoxyItemize}
\item start = 2021-\/02-\/26 13\+:30
\item end = 2021-\/02-\/26 14\+:15
\item moderator = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\item reviewer = Klemens Boeswirth
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keySetMeta_md_autotoc_md1334}{}\doxysection{Signature}\label{doc_contrib_api_reviews_core_keySetMeta_md_autotoc_md1334}
{\ttfamily ssize\+\_\+t \mbox{\hyperlink{group__keymeta_gae1f15546b234ffb6007d8a31178652b9}{key\+Set\+Meta(\+Key $\ast$key, const char$\ast$ meta\+Name,const char $\ast$new\+Meta\+String)}}}\hypertarget{doc_contrib_api_reviews_core_keySetMeta_md_autotoc_md1335}{}\doxysection{Checklist}\label{doc_contrib_api_reviews_core_keySetMeta_md_autotoc_md1335}
\hypertarget{doc_contrib_api_reviews_core_keySetMeta_md_autotoc_md1336}{}\doxysubsubsection{Doxygen}\label{doc_contrib_api_reviews_core_keySetMeta_md_autotoc_md1336}
(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{]} Set the value of a meta-\/information key
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Simple example or snippet how to use the function ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add simple example
\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{]} improve description
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @pre} ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} key should not have read-\/only metadata ~\newline

\item \mbox{[}x\mbox{]} meta\+Name must be a valid key name
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @post} ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} value set ~\newline

\item \mbox{[}x\mbox{]} Key has a meta-\/information Keyset (?)
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @invariant} ~\newline

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} meta\+Name -\/ add dot, split into two lines
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @return} / {\ttfamily @retval} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} split {\ttfamily -\/1} into multiple lines
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @since} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add {\ttfamily 1.\+0.\+0}
\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_contrib_api_reviews_core_keySetMeta_md_autotoc_md1337}{}\doxysubsection{Naming}\label{doc_contrib_api_reviews_core_keySetMeta_md_autotoc_md1337}

\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{]} new\+Meta\+String -\/$>$ meta\+Value
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Parameter names should be clear and unambiguous ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} new\+Meta\+String -\/$>$ meta\+Value
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keySetMeta_md_autotoc_md1338}{}\doxysubsection{Compatibility}\label{doc_contrib_api_reviews_core_keySetMeta_md_autotoc_md1338}
(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_keySetMeta_md_autotoc_md1339}{}\doxysubsection{Parameter \& Return Types}\label{doc_contrib_api_reviews_core_keySetMeta_md_autotoc_md1339}

\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_keySetMeta_md_autotoc_md1340}{}\doxysubsection{Structural Clarity}\label{doc_contrib_api_reviews_core_keySetMeta_md_autotoc_md1340}

\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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily key\+Del\+Meta()} ? ~\newline

\item Similar thing could be achieved with ~\newline
 {\ttfamily ks\+Append\+Key ( key\+Meta (key), key\+New (meta\+Name, KEY\+\_\+\+VALUE, new\+Meta\+String, KEY\+\_\+\+END) )}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keySetMeta_md_autotoc_md1341}{}\doxysubsection{Memory Management}\label{doc_contrib_api_reviews_core_keySetMeta_md_autotoc_md1341}

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

\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_keySetMeta_md_autotoc_md1343}{}\doxysubsection{Tests}\label{doc_contrib_api_reviews_core_keySetMeta_md_autotoc_md1343}

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

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} memory errors hard to cover
\end{DoxyItemize}
\item \mbox{[} \mbox{]} All possible error states are covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} memory errors hard to cover
\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{]} test case for key 0 ~\newline

\item \mbox{[}x\mbox{]} test case for name 0 ~\newline

\item \mbox{[} \mbox{]} test case for invalid name
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keySetMeta_md_autotoc_md1344}{}\doxysection{Summary}\label{doc_contrib_api_reviews_core_keySetMeta_md_autotoc_md1344}

\begin{DoxyItemize}
\item For 1.\+0.\+0 only meta\+Names with namespace {\ttfamily meta\+:/} should be accepted
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_keySetMeta_md_autotoc_md1345}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_contrib_api_reviews_core_keySetMeta_md_autotoc_md1345}
