\label{doc_api_review_core_ksSetCursor_md_md_doc_api_review_core_ksSetCursor}%
\Hypertarget{doc_api_review_core_ksSetCursor_md_md_doc_api_review_core_ksSetCursor}%

\begin{DoxyItemize}
\item start = 2021-\/03-\/14 21\+:20
\item end = 2021-\/03-\/14 21\+:40
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksSetCursor_md_autotoc_md1484}{}\doxysection{Signature}\label{doc_api_review_core_ksSetCursor_md_autotoc_md1484}
{\ttfamily int \mbox{\hyperlink{group__keyset_ga28b2a7d13c620b3c9d4815a0608c738f}{ks\+Set\+Cursor(\+Key\+Set $\ast$ks, elektra\+Cursor cursor)}}}\hypertarget{doc_api_review_core_ksSetCursor_md_autotoc_md1485}{}\doxysection{Checklist}\label{doc_api_review_core_ksSetCursor_md_autotoc_md1485}
\hypertarget{doc_api_review_core_ksSetCursor_md_autotoc_md1486}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_ksSetCursor_md_autotoc_md1486}
(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{]} append to \textquotesingle{}to the given {\ttfamily cursor}\textquotesingle{}
\end{DoxyItemize}
\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{[}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{[}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{]} add {\ttfamily \mbox{\hyperlink{group__keyset_ga4287b9416912c5f2ab9c195cb74fb094}{ks\+Current()}}} to {\ttfamily \mbox{\hyperlink{group__keyset_ga317321c9065b5a4b3e33fe1c399bcec9}{ks\+Next()}}} ~\newline

\item \mbox{[} \mbox{]} move {\ttfamily ks\+Get\+Cursor} to its own line
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksSetCursor_md_autotoc_md1487}{}\doxysubsection{Naming}\label{doc_api_review_core_ksSetCursor_md_autotoc_md1487}

\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{[}x\mbox{]} Function name should be clear and unambiguous
\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{[} \mbox{]} Parameter names should neither be too long, nor too short ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily ks} -\/$>$ {\ttfamily key\+Set}
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Parameter names should be clear and unambiguous
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksSetCursor_md_autotoc_md1488}{}\doxysubsection{Compatibility}\label{doc_api_review_core_ksSetCursor_md_autotoc_md1488}
(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_ksSetCursor_md_autotoc_md1489}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_ksSetCursor_md_autotoc_md1489}

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

\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{[}x\mbox{]} No functions with similar purpose exist
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksSetCursor_md_autotoc_md1491}{}\doxysubsection{Memory Management}\label{doc_api_review_core_ksSetCursor_md_autotoc_md1491}

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

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

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} Function code is fully covered by tests
\item \mbox{[} \mbox{]} All possible error states are covered by tests ~\newline

\begin{DoxyItemize}
\item \mbox{[}x\mbox{]} {\ttfamily ks == NULL} ~\newline

\item \mbox{[}x\mbox{]} {\ttfamily cursor == -\/1}
\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_ksSetCursor_md_autotoc_md1494}{}\doxysection{Summary}\label{doc_api_review_core_ksSetCursor_md_autotoc_md1494}
return values are never checked in tests\hypertarget{doc_api_review_core_ksSetCursor_md_autotoc_md1495}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_ksSetCursor_md_autotoc_md1495}
