\label{doc_api_review_core_ksAtCursor_md_md_doc_api_review_core_ksAtCursor}%
\Hypertarget{doc_api_review_core_ksAtCursor_md_md_doc_api_review_core_ksAtCursor}%

\begin{DoxyItemize}
\item start = 2021-\/03-\/14 10\+:35
\item end = 2021-\/03-\/14 11\+:00
\item reviewer = Stefan Hanreich \href{mailto:stefanhani@gmail.com}{\texttt{ stefanhani@gmail.\+com}}
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksAtCursor_md_autotoc_md1266}{}\doxysection{Signature}\label{doc_api_review_core_ksAtCursor_md_autotoc_md1266}
{\ttfamily Key $\ast$ks\+At\+Cursor(Key\+Set $\ast$ks, elektra\+Cursor cursor)}\hypertarget{doc_api_review_core_ksAtCursor_md_autotoc_md1267}{}\doxysection{Checklist}\label{doc_api_review_core_ksAtCursor_md_autotoc_md1267}
\hypertarget{doc_api_review_core_ksAtCursor_md_autotoc_md1268}{}\doxysubsubsection{Doxygen}\label{doc_api_review_core_ksAtCursor_md_autotoc_md1268}
(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{]} \textquotesingle{}Return key at the position given by cursor {\ttfamily pos}\textquotesingle{}
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Simple example or snippet how to use the function ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} add
\end{DoxyItemize}
\item \mbox{[} \mbox{]} Longer description of function containing common use cases ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} Doesnt seem to be accurate, change to cursor
\end{DoxyItemize}
\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{[} \mbox{]} {\ttfamily @param} for every parameter ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily pos}\+: \textquotesingle{}the cursor of the key that should be retrieved\textquotesingle{}
\end{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily @return} / {\ttfamily @retval} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} split {\ttfamily @retval} into multiple lines
\end{DoxyItemize}
\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_gace0444eb8ec958a429794f8586fc72e7}{ks\+Get\+Cursor()}}} ~\newline

\item \mbox{[} \mbox{]} add {\ttfamily \mbox{\hyperlink{group__keyset_ga28b2a7d13c620b3c9d4815a0608c738f}{ks\+Set\+Cursor()}}}
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksAtCursor_md_autotoc_md1269}{}\doxysubsection{Naming}\label{doc_api_review_core_ksAtCursor_md_autotoc_md1269}

\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 keyset} ~\newline

\item \mbox{[} \mbox{]} {\ttfamily pos} -\/$>$ {\ttfamily position}
\end{DoxyItemize}
\item \mbox{[}x\mbox{]} Parameter names should be clear and unambiguous
\end{DoxyItemize}\hypertarget{doc_api_review_core_ksAtCursor_md_autotoc_md1270}{}\doxysubsection{Compatibility}\label{doc_api_review_core_ksAtCursor_md_autotoc_md1270}
(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_ksAtCursor_md_autotoc_md1271}{}\doxysubsection{Parameter \& Return Types}\label{doc_api_review_core_ksAtCursor_md_autotoc_md1271}

\begin{DoxyItemize}
\item Function parameters should use enum types instead of boolean types wherever sensible
\item \mbox{[} \mbox{]} Wherever possible, function parameters should be {\ttfamily const} ~\newline

\begin{DoxyItemize}
\item \mbox{[} \mbox{]} {\ttfamily ks} maybe could be {\ttfamily const}?
\end{DoxyItemize}
\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_ksAtCursor_md_autotoc_md1272}{}\doxysubsection{Structural Clarity}\label{doc_api_review_core_ksAtCursor_md_autotoc_md1272}

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

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

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

\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{[} \mbox{]} add test case for {\ttfamily pos} $>$= {\ttfamily ks-\/$>$size}
\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_ksAtCursor_md_autotoc_md1276}{}\doxysection{Summary}\label{doc_api_review_core_ksAtCursor_md_autotoc_md1276}
\hypertarget{doc_api_review_core_ksAtCursor_md_autotoc_md1277}{}\doxysection{Other Issues discovered (unrelated to function)}\label{doc_api_review_core_ksAtCursor_md_autotoc_md1277}
