在 R 文档文件中，如何在小节中包含列表

Question

我有一些像这样工作的氧气

#' @return
#' \subsection{foo} {
#'    \item{bar}{all about bar}
#' }

R 死于此说它不知道宏 \item。如果我删除该小节，它会起作用。

#' @return
#'    \item{bar}{all about bar}

这行得通。

有什么方法可以在小节中获取我的栏目吗？

Answer 1

在@return 中有一个隐含的 \describe 环境，\subsection 破坏了它。

这行得通

#' @return
#' \subsection{foo} {
#'    \describe{
#'      \item{bar}{all about bar}
#'    }
#' }

参见第 2.2.1 节，https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Documenting-functions 中的 \value{…} 中的 "Documenting Functions" 内容为 "Note that \value is implicitly a \describe environment, so that environment should not be used for listing components, just individual \item{}{} entries."

in an R documentation file, how can I include a list in a subsection