\label{doc_contrib_api_reviews_core_ksVNew_md_md_doc_contrib_api_reviews_core_ksVNew}%
\Hypertarget{doc_contrib_api_reviews_core_ksVNew_md_md_doc_contrib_api_reviews_core_ksVNew}%

\begin{DoxyItemize}
\item start = 2021-\/03-\/14 21\+:40
\item end = 2021-\/03-\/14 22\+:15
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_ksVNew_md_autotoc_md1661}{}\doxysection{Signature}\label{doc_contrib_api_reviews_core_ksVNew_md_autotoc_md1661}
{\ttfamily Key\+Set $\ast$ks\+VNew(size\+\_\+t alloc, va\+\_\+list ap)}\hypertarget{doc_contrib_api_reviews_core_ksVNew_md_autotoc_md1662}{}\doxysection{Checklist}\label{doc_contrib_api_reviews_core_ksVNew_md_autotoc_md1662}
\hypertarget{doc_contrib_api_reviews_core_ksVNew_md_autotoc_md1663}{}\doxysubsubsection{Doxygen}\label{doc_contrib_api_reviews_core_ksVNew_md_autotoc_md1663}
(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{]} move up
\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{]} \textquotesingle{}you should read the next statements\textquotesingle{} seems a bit strange ~\newline

\item \mbox{[} \mbox{]} remove \textquotesingle{}va the list of arguments\textquotesingle{} heading
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @pre} ~\newline

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

\item \mbox{[} \mbox{]} add more
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @post} ~\newline

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

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @param} for every parameter ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} delete the first one ~\newline

\item \mbox{[} \mbox{]} move below conditions / invariants ~\newline

\item \mbox{[} \mbox{]} improve description for alloc\+: clarify hint
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} {\ttfamily @return} / {\ttfamily @retval}
\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{]} move to bottom ~\newline

\item \mbox{[} \mbox{]} add {\ttfamily \mbox{\hyperlink{group__key_gad23c65b44bf48d773759e1f9a4d43b89}{key\+New()}}}? ~\newline

\item \mbox{[} \mbox{]} add {\ttfamily \mbox{\hyperlink{group__keyset_ga671e1aaee3ae9dc13b4834a4ddbd2c3c}{ks\+New()}}}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_ksVNew_md_autotoc_md1664}{}\doxysubsection{Naming}\label{doc_contrib_api_reviews_core_ksVNew_md_autotoc_md1664}

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Abbreviations used in function names must be defined in the \mbox{\hyperlink{doc_help_elektra-glossary_md}{Glossary}} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} define {\ttfamily ks}
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Function names should neither be too long, nor too short
\item \mbox{[} \mbox{]} Function name should be clear and unambiguous ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} What does the {\ttfamily V} mean?
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Abbreviations used in parameter names must be defined in the \mbox{\hyperlink{doc_help_elektra-glossary_md}{Glossary}} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} define {\ttfamily ks}
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Parameter names should neither be too long, nor too short
\item \mbox{[} \mbox{]} Parameter names should be clear and unambiguous ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily alloc} -\/$>$ {\ttfamily size} / {\ttfamily initial\+Size} ~\newline

\item \mbox{[} \mbox{]} {\ttfamily va} -\/$>$ {\ttfamily params} / {\ttfamily parameters} / {\ttfamily va\+\_\+list}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_ksVNew_md_autotoc_md1665}{}\doxysubsection{Compatibility}\label{doc_contrib_api_reviews_core_ksVNew_md_autotoc_md1665}
(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_ksVNew_md_autotoc_md1666}{}\doxysubsection{Parameter \& Return Types}\label{doc_contrib_api_reviews_core_ksVNew_md_autotoc_md1666}

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

\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
\item \mbox{[} \mbox{]} No functions with similar purpose exist ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} difference to {\ttfamily \mbox{\hyperlink{group__key_gad23c65b44bf48d773759e1f9a4d43b89}{key\+New()}}}?
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_contrib_api_reviews_core_ksVNew_md_autotoc_md1668}{}\doxysubsection{Memory Management}\label{doc_contrib_api_reviews_core_ksVNew_md_autotoc_md1668}

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

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

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

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Line 254 ~\newline

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

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} above error cases seem hard to test
\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_contrib_api_reviews_core_ksVNew_md_autotoc_md1671}{}\doxysection{Summary}\label{doc_contrib_api_reviews_core_ksVNew_md_autotoc_md1671}
Is this function still needed? Is it necessary to provide raw access, as key\+New is just a wrapper for this function that performs actions, which the user has to manually perform when using {\ttfamily \mbox{\hyperlink{key_8c_a307cb9b84dec7fe607720a5eb4103226}{key\+VNew()}}}.\hypertarget{doc_contrib_api_reviews_core_ksVNew_md_autotoc_md1672}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_contrib_api_reviews_core_ksVNew_md_autotoc_md1672}
