diff --git a/vignettes/rd-other.Rmd b/vignettes/rd-other.Rmd index 8c9cf0ef..dab6d5f5 100644 --- a/vignettes/rd-other.Rmd +++ b/vignettes/rd-other.Rmd @@ -42,6 +42,8 @@ This means you need to document them in a slightly different way: instead of doc #' \item{depth}{total depth percentage = z / mean(x, y) = 2 * z / (x + y) (43--79)} #' \item{table}{width of top of diamond relative to widest point (43--95)} #' } +#' +#' @source {ggplot2} tidyverse R package. ``` Note the use of two additional tags that are particularly useful for documenting data: diff --git a/vignettes/rd.Rmd b/vignettes/rd.Rmd index e9556cef..7e5895d8 100644 --- a/vignettes/rd.Rmd +++ b/vignettes/rd.Rmd @@ -80,7 +80,7 @@ This is unnecessary unless you want to have a multi-paragraph description, bulle ## Functions -Functions are the mostly commonly documented objects. +Functions are the most commonly documented objects. Functions require three tags: `@param`, `@returns`, and `@examples`. ### Inputs @@ -134,5 +134,5 @@ All functions must have a documented return value for initial CRAN submission. ### Usage In most case, the function usage (which appears beneath the description in the generates docs) will be automatically derived from the function specification. -For the cases where it is not, please [file an issue](https://github.com/r-lib/roxygen2/issues) and use `@usage` to override the default with you want. +For the cases where it is not, please [file an issue](https://github.com/r-lib/roxygen2/issues) and use `@usage` to override the default with what you want. If you want to suppress the usage altogether (which is sometimes useful for internal or deprecated functions), you can use `@usage NULL`.