Skip to content

Commit 6e8ac77

Browse files
jan-glxJan Gleixnerteunbrand
authored
in ?scale_color_continous, add link to ?continuous_scale (#6691)
* add link to ?continuous_scale to ?scale_color_continous Adding `continuous_scale` to @Seealso of ?scale_color_continous allows to more easily discover potential parameters to supply in `...` like `transform` or `limits`. * improve see also links in docs of color scales add scale_(color|fill)_discrete to @family color scales remove explit @Seealso links from ?scale_(color|fill)_(continous|binned) that are redundant due to links provided through @family add @Seealso links for discrete_scale continous_scale and binned_scales to scale_(fill|color)_(discrete|binned|continous) as appropiate * add links to ?scale_(colour|fill)_(discrete|continuous|binned) specifically, links to ?(discrete|continous|binned)_scale function in the description of the `...` parameter * Use `@inheritParams` for `...` --------- Co-authored-by: Jan Gleixner <jan.gleixner+git@gmail.com> Co-authored-by: Teun van den Brand <tahvdbrand@gmail.com>
1 parent 6eb05bc commit 6e8ac77

12 files changed

+173
-10
lines changed

R/scale-colour.R

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,13 @@
2626
#' * a single string naming a palette.
2727
#' * a palette function that when called with a numeric vector with values
2828
#' between 0 and 1 returns the corresponding output values.
29-
#' @param ... Additional parameters passed on to the scale type
29+
#' @inheritDotParams continuous_scale -scale_name -trans -minor_breaks -expand
30+
#' @inheritDotParams binned_scale -scale_name -trans -expand
3031
#' @param type `r lifecycle::badge("superseded")` One of the following:
3132
#' * "gradient" (the default)
3233
#' * "viridis"
3334
#' * A function that returns a continuous colour scale.
34-
#' @seealso [scale_colour_gradient()], [scale_colour_viridis_c()],
35-
#' [scale_colour_steps()], [scale_colour_viridis_b()], [scale_fill_gradient()],
36-
#' [scale_fill_viridis_c()], [scale_fill_steps()], and [scale_fill_viridis_b()]
35+
#' @seealso [continuous_scale()] and [binned_scale()]
3736
#'
3837
#' The documentation on [colour aesthetics][aes_colour_fill_alpha].
3938
#' @family colour scales
@@ -173,7 +172,7 @@ scale_fill_binned <- function(..., palette = NULL, aesthetics = "fill", guide =
173172
#' * a single string naming a palette.
174173
#' * a palette function that when called with a single integer argument (the
175174
#' number of levels in the scale) returns the values that they should take.
176-
#' @param ... Additional parameters passed on to the scale type,
175+
#' @inheritDotParams discrete_scale -scale_name -expand -position -minor_breaks
177176
#' @inheritParams discrete_scale
178177
#' @param type `r lifecycle::badge("superseded")` The preferred mechanism for
179178
#' setting the default palette is by using the theme. For example:
@@ -190,6 +189,8 @@ scale_fill_binned <- function(..., palette = NULL, aesthetics = "fill", guide =
190189
#' * A function that returns a discrete colour/fill scale (e.g., [scale_fill_hue()],
191190
#' [scale_fill_brewer()], etc).
192191
#' @export
192+
#' @seealso [discrete_scale()]
193+
#' @family colour scales
193194
#' @seealso
194195
#' The `r link_book("discrete colour scales section", "scales-colour#sec-colour-discrete")`
195196
#' @examples

man/scale_alpha.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/scale_brewer.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/scale_colour_continuous.Rd

Lines changed: 93 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/scale_colour_discrete.Rd

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

man/scale_gradient.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/scale_grey.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/scale_hue.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/scale_identity.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/scale_manual.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)