Skip to content

Commit

Permalink
Minor typos in documentation (#1500)
Browse files Browse the repository at this point in the history
  • Loading branch information
bahadzie committed Nov 1, 2023
1 parent a34bdf7 commit 07c0ebf
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 2 additions & 0 deletions vignettes/rd-other.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions vignettes/rd.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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`.

0 comments on commit 07c0ebf

Please sign in to comment.