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

Question

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

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

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

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

这有效。

有什么方法可以让我在小节中获得我的酒吧项目吗？

score 0 · Accepted Answer

在 @return 中有一个隐含的\describe环境\subsection中断。

这会起作用

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

请参阅https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Documenting-functions中的第 2.2.1 节“记录功能”，\value{…}其中写道，“注意 \value 是隐含一个 \describe 环境，因此该环境不应该用于列出组件，而只是单独的 \item{}{} 条目。"

1 回答 1