Skip to content

Commit 2da2b27

Browse files
authored
document options more explicitly (#6709)
1 parent a27af21 commit 2da2b27

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

R/labels.R

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,13 @@ make_labels <- function(mapping) {
175175
#' See [get_alt_text] for examples. `alt` can also be a function that
176176
#' takes the plot as input and returns text as output. `alt` also accepts
177177
#' rlang [lambda][rlang::as_function()] function notation.
178-
#' @param ... A list of new name-value pairs. The name should be an aesthetic.
178+
#' @param ...
179+
#' New name-value pairs. The name should be an aesthetic. The values can be
180+
#' one of the following:
181+
#' * A string or expression to set a label verbatim.
182+
#' * A function to use as formatter for the default label.
183+
#' * `NULL` to remove a label.
184+
#' * A [`waiver()`] to use the default label.
179185
#' @export
180186
#'
181187
#' @seealso

man/labs.Rd

Lines changed: 8 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)