
\begin{DoxyItemize}
\item start = 2021-\/02-\/27 17\+:30
\item end = 2021-\/02-\/27 17\+:45
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_keyCopyMeta_autotoc_md780}{}\doxysection{Signature}\label{md_doc_api_review_core_keyCopyMeta_autotoc_md780}
{\ttfamily int \mbox{\hyperlink{group__keymeta_ga9a22b992478e613c8788bd460b4a1f0c}{key\+Copy\+Meta(\+Key $\ast$dest, const Key $\ast$source, const char $\ast$meta\+Name)}}}\hypertarget{md_doc_api_review_core_keyCopyMeta_autotoc_md781}{}\doxysection{Checklist}\label{md_doc_api_review_core_keyCopyMeta_autotoc_md781}
\hypertarget{md_doc_api_review_core_keyCopyMeta_autotoc_md782}{}\doxysubsubsection{Doxygen}\label{md_doc_api_review_core_keyCopyMeta_autotoc_md782}
(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{]} of metadata -\/$>$ of the meta\+Data with name {\ttfamily meta\+Name}
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Simple example or snippet how to use the function ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} move below {\ttfamily @brief}
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Longer description of function containing common use cases ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} describe the functionality more explicitly where meta-\/information gets deleted when {\ttfamily source}\textquotesingle{}s {\ttfamily meta\+Name} is not set in {\ttfamily dest} ~\newline

\item \mbox{[} \mbox{]} add information that it does nothing on read-\/only keys
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Description of functions reads nicely ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} it will take -\/$>$ will take
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @pre} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} \textquotesingle{}dest is a valid Key\textquotesingle{} ~\newline

\item \mbox{[} \mbox{]} \textquotesingle{}source is a valid Key\textquotesingle{}
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} {\ttfamily @post}
\item \mbox{[} \mbox{]} {\ttfamily @invariant} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} \textquotesingle{}dest stays a valid Key\textquotesingle{} ~\newline

\item \mbox{[} \mbox{]} \textquotesingle{}source stays a valid Key\textquotesingle{}
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @param} for every parameter ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} too -\/$>$ to ~\newline

\item \mbox{[} \mbox{]} name of the metadata -\/$>$ name of the key in the metadata
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @return} / {\ttfamily @retval} ~\newline

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

\item \mbox{[} \mbox{]} add {\ttfamily -\/1} if meta-\/information is 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{]} add {\ttfamily \mbox{\hyperlink{group__keymeta_ga8e63720a65610a29597494d0671f9401}{key\+Copy\+All\+Meta()}}}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_keyCopyMeta_autotoc_md783}{}\doxysubsection{Naming}\label{md_doc_api_review_core_keyCopyMeta_autotoc_md783}

\begin{DoxyItemize}
\item Abbreviations used in function names must be defined in the 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 \mbox{[}x\mbox{]} Abbreviations used in parameter names must be defined in the 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{md_doc_api_review_core_keyCopyMeta_autotoc_md784}{}\doxysubsection{Compatibility}\label{md_doc_api_review_core_keyCopyMeta_autotoc_md784}
(only in PRs)


\begin{DoxyItemize}
\item 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{md_doc_api_review_core_keyCopyMeta_autotoc_md785}{}\doxysubsection{Parameter \& Return Types}\label{md_doc_api_review_core_keyCopyMeta_autotoc_md785}

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

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

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

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

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Lines 294\+:298
\end{DoxyItemize}
\item \mbox{[} \mbox{]} All possible error states are covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add test case for clearing meta-\/information key
\end{DoxyItemize}
\item All possible enum values are covered by tests
\item \mbox{[}x\mbox{]} No inconsistencies between tests and documentation
\end{DoxyItemize}\hypertarget{md_doc_api_review_core_keyCopyMeta_autotoc_md790}{}\doxysection{Summary}\label{md_doc_api_review_core_keyCopyMeta_autotoc_md790}
\hypertarget{md_doc_api_review_core_keyCopyMeta_autotoc_md791}{}\doxysection{Other Issues discovered (unrelated to function)}\label{md_doc_api_review_core_keyCopyMeta_autotoc_md791}
