From b943e494250310daa8eb9ed7ca536a9f4d6826e9 Mon Sep 17 00:00:00 2001 From: Olivier Roy Date: Thu, 7 Mar 2024 18:43:24 -0500 Subject: [PATCH] Avoid documenting `scale_name` with `@inheritDotParams discrete_scale` --- R/scale-discrete-.R | 2 +- R/scale-grey.R | 2 +- R/scale-hue.R | 2 +- R/scale-linetype.R | 2 +- R/scale-manual.R | 2 +- R/scale-shape.R | 2 +- man/scale_discrete.Rd | 2 -- man/scale_grey.Rd | 2 -- man/scale_hue.Rd | 2 -- man/scale_linetype.Rd | 2 -- man/scale_manual.Rd | 2 -- man/scale_shape.Rd | 2 -- 12 files changed, 6 insertions(+), 18 deletions(-) diff --git a/R/scale-discrete-.R b/R/scale-discrete-.R index 1a8228e318..268448f844 100644 --- a/R/scale-discrete-.R +++ b/R/scale-discrete-.R @@ -10,7 +10,7 @@ #' level, and increasing by one for each level (i.e. the labels are placed #' at integer positions). This is what allows jittering to work. #' -#' @inheritDotParams discrete_scale +#' @inheritDotParams discrete_scale -scale_name #' @inheritParams discrete_scale #' @rdname scale_discrete #' @family position scales diff --git a/R/scale-grey.R b/R/scale-grey.R index b0820d34de..8fee2af218 100644 --- a/R/scale-grey.R +++ b/R/scale-grey.R @@ -5,7 +5,7 @@ #' #' @inheritParams scales::pal_grey #' @inheritParams scale_colour_hue -#' @inheritDotParams discrete_scale +#' @inheritDotParams discrete_scale -scale_name #' @family colour scales #' @seealso #' The documentation on [colour aesthetics][aes_colour_fill_alpha]. diff --git a/R/scale-hue.R b/R/scale-hue.R index 45a4c88894..1737566088 100644 --- a/R/scale-hue.R +++ b/R/scale-hue.R @@ -4,7 +4,7 @@ #' It does not generate colour-blind safe palettes. #' #' @param na.value Colour to use for missing values -#' @inheritDotParams discrete_scale -aesthetics +#' @inheritDotParams discrete_scale -aesthetics -scale_name #' @param aesthetics Character string or vector of character strings listing the #' name(s) of the aesthetic(s) that this scale works with. This can be useful, for #' example, to apply colour settings to the `colour` and `fill` aesthetics at the diff --git a/R/scale-linetype.R b/R/scale-linetype.R index 74ba059ffd..a1b983b23d 100644 --- a/R/scale-linetype.R +++ b/R/scale-linetype.R @@ -6,7 +6,7 @@ #' no inherent order, this use is not advised. #' #' @inheritParams scale_x_discrete -#' @inheritDotParams discrete_scale -expand -position -na.value +#' @inheritDotParams discrete_scale -expand -position -na.value -scale_name #' @param na.value The linetype to use for `NA` values. #' @rdname scale_linetype #' @seealso diff --git a/R/scale-manual.R b/R/scale-manual.R index 3f9bfb592f..2ebe151e56 100644 --- a/R/scale-manual.R +++ b/R/scale-manual.R @@ -12,7 +12,7 @@ #' of aesthetics provided via the `aesthetics` argument. #' #' @inheritParams scale_x_discrete -#' @inheritDotParams discrete_scale -expand -position -aesthetics +#' @inheritDotParams discrete_scale -expand -position -aesthetics -scale_name #' @param aesthetics Character string or vector of character strings listing the #' name(s) of the aesthetic(s) that this scale works with. This can be useful, for #' example, to apply colour settings to the `colour` and `fill` aesthetics at the diff --git a/R/scale-shape.R b/R/scale-shape.R index 22d5202459..7c4c750519 100644 --- a/R/scale-shape.R +++ b/R/scale-shape.R @@ -10,7 +10,7 @@ #' @param solid Should the shapes be solid, `TRUE`, or hollow, #' `FALSE`? #' @inheritParams scale_x_discrete -#' @inheritDotParams discrete_scale -expand -position +#' @inheritDotParams discrete_scale -expand -position -scale_name #' @rdname scale_shape #' @seealso #' The documentation for [differentiation related aesthetics][aes_linetype_size_shape]. diff --git a/man/scale_discrete.Rd b/man/scale_discrete.Rd index 3955316322..7da721f97e 100644 --- a/man/scale_discrete.Rd +++ b/man/scale_discrete.Rd @@ -61,8 +61,6 @@ from a discrete scale, specify \code{na.translate = FALSE}.} missing values be displayed as? Does not apply to position scales where \code{NA} is always placed at the far right.} \item{\code{aesthetics}}{The names of the aesthetics that this scale works with.} - \item{\code{scale_name}}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}} The name of the scale -that should be used for error messages associated with this scale.} \item{\code{labels}}{One of: \itemize{ \item \code{NULL} for no labels diff --git a/man/scale_grey.Rd b/man/scale_grey.Rd index 2dd9cf724e..93b06ff821 100644 --- a/man/scale_grey.Rd +++ b/man/scale_grey.Rd @@ -60,8 +60,6 @@ The default, \code{TRUE}, uses the levels that appear in the data; \item{\code{na.translate}}{Unlike continuous scales, discrete scales can easily show missing values, and do so by default. If you want to remove missing values from a discrete scale, specify \code{na.translate = FALSE}.} - \item{\code{scale_name}}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}} The name of the scale -that should be used for error messages associated with this scale.} \item{\code{labels}}{One of: \itemize{ \item \code{NULL} for no labels diff --git a/man/scale_hue.Rd b/man/scale_hue.Rd index 80e9852057..1501b89462 100644 --- a/man/scale_hue.Rd +++ b/man/scale_hue.Rd @@ -66,8 +66,6 @@ The default, \code{TRUE}, uses the levels that appear in the data; \item{\code{na.translate}}{Unlike continuous scales, discrete scales can easily show missing values, and do so by default. If you want to remove missing values from a discrete scale, specify \code{na.translate = FALSE}.} - \item{\code{scale_name}}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}} The name of the scale -that should be used for error messages associated with this scale.} \item{\code{labels}}{One of: \itemize{ \item \code{NULL} for no labels diff --git a/man/scale_linetype.Rd b/man/scale_linetype.Rd index 49b7e10bb4..a117e9a49e 100644 --- a/man/scale_linetype.Rd +++ b/man/scale_linetype.Rd @@ -52,8 +52,6 @@ The default, \code{TRUE}, uses the levels that appear in the data; missing values, and do so by default. If you want to remove missing values from a discrete scale, specify \code{na.translate = FALSE}.} \item{\code{aesthetics}}{The names of the aesthetics that this scale works with.} - \item{\code{scale_name}}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}} The name of the scale -that should be used for error messages associated with this scale.} \item{\code{labels}}{One of: \itemize{ \item \code{NULL} for no labels diff --git a/man/scale_manual.Rd b/man/scale_manual.Rd index 6f8234a051..5528bef88a 100644 --- a/man/scale_manual.Rd +++ b/man/scale_manual.Rd @@ -62,8 +62,6 @@ The default, \code{TRUE}, uses the levels that appear in the data; \item{\code{na.translate}}{Unlike continuous scales, discrete scales can easily show missing values, and do so by default. If you want to remove missing values from a discrete scale, specify \code{na.translate = FALSE}.} - \item{\code{scale_name}}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}} The name of the scale -that should be used for error messages associated with this scale.} \item{\code{name}}{The name of the scale. Used as the axis or legend title. If \code{waiver()}, the default, the name of the scale is taken from the first mapping used for that aesthetic. If \code{NULL}, the legend title will be diff --git a/man/scale_shape.Rd b/man/scale_shape.Rd index 2e1ce1512e..3dcd3496e8 100644 --- a/man/scale_shape.Rd +++ b/man/scale_shape.Rd @@ -52,8 +52,6 @@ from a discrete scale, specify \code{na.translate = FALSE}.} missing values be displayed as? Does not apply to position scales where \code{NA} is always placed at the far right.} \item{\code{aesthetics}}{The names of the aesthetics that this scale works with.} - \item{\code{scale_name}}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}} The name of the scale -that should be used for error messages associated with this scale.} \item{\code{labels}}{One of: \itemize{ \item \code{NULL} for no labels