Skip to content

Use \describe with \item{}{} for list #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
eddelbuettel wants to merge 1 commit into from
Closed

Use \describe with \item{}{} for list #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions R/document.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@
#' comments and generates Rd files and NAMESPACE.
#'
#' @param path Path to package root directory. Default is current directory.
#' @param namespace How to handle NAMESPACE generation. One of:
#' - "overwrite": Fully regenerate NAMESPACE (default)
#' - "append": Insert between ## rhydrogen start/end markers
#' - "none": Don't modify NAMESPACE
#'
#' @param namespace How to handle NAMESPACE generation. One of
#' \describe{
#' \item{"overwrite"}{Fully regenerate NAMESPACE (default)}
#' \item{"append"}{Insert between ## rhydrogen start/end markers}
#' \item{"none"}{Don't modify NAMESPACE}
#' }
#' @return Invisibly returns a list with:
#' - rd_files: character vector of generated Rd file paths
#' - namespace: path to NAMESPACE file (or NULL if mode="none")
Expand Down
10 changes: 6 additions & 4 deletions man/document.Rd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@ document(path = ".", namespace = c("overwrite", "append", "none"))
\arguments{
\item{path}{Path to package root directory. Default is current directory.}

\item{namespace}{How to handle NAMESPACE generation. One of:
- "overwrite": Fully regenerate NAMESPACE (default)
- "append": Insert between ## rhydrogen start/end markers
- "none": Don't modify NAMESPACE}
\item{namespace}{How to handle NAMESPACE generation. One of
\describe{
\item{"overwrite"}{Fully regenerate NAMESPACE (default)}
\item{"append"}{Insert between ## rhydrogen start/end markers}
\item{"none"}{Don't modify NAMESPACE}
}}
}
\value{
Invisibly returns a list with:
Expand Down