From d924136c2fc4c82368231579965488c673756ef4 Mon Sep 17 00:00:00 2001 From: Elio Campitelli Date: Mon, 14 Oct 2024 17:55:55 +1100 Subject: [PATCH] Updates documentation --- NEWS.md | 2 +- man/discretised_scale.Rd | 6 +++--- man/label_scales.Rd | 6 +++--- man/scale_divergent.Rd | 6 +++--- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/NEWS.md b/NEWS.md index b7838627..8eb385ab 100644 --- a/NEWS.md +++ b/NEWS.md @@ -8,7 +8,7 @@ ## Breaking changes -- The `GetSMNData()` function is defunct. The functionality is a hack and hard to maintain and it's also very specific and should be out of scope for a general package. +- The `GetSMNData()` function is defunct. The functionality was a hack and hard to maintain and it's also very specific and should be out of scope for a general package. - The `trans` argument of scales has been renamed to `transform` following ggplot2's change. - `scale_mag()` internals are now much simpler and inherits all the functionality from common continuous scales. (thanks @teunbrand for the suggestion, #186) - The `step` computed variable in `geom_streamline()` now goes from 0 to the total number of steps instead of from negative half to positive half. diff --git a/man/discretised_scale.Rd b/man/discretised_scale.Rd index 64e46632..62b8442f 100644 --- a/man/discretised_scale.Rd +++ b/man/discretised_scale.Rd @@ -75,13 +75,13 @@ Also accepts rlang \link[rlang:as_function]{lambda} function notation. \item{\code{minor_breaks}}{One of: \itemize{ \item \code{NULL} for no minor breaks -\item \code{waiver()} for the default breaks (one minor break between -each major break) +\item \code{waiver()} for the default breaks (none for discrete, one minor break +between each major break for continuous) \item A numeric vector of positions \item A function that given the limits returns a vector of minor breaks. Also accepts rlang \link[rlang:as_function]{lambda} function notation. When the function has two arguments, it will be given the limits and major -breaks. +break positions. }} \item{\code{n.breaks}}{An integer guiding the number of major breaks. The algorithm may choose a slightly different number to ensure nice break labels. Will diff --git a/man/label_scales.Rd b/man/label_scales.Rd index 7b72a5c1..67d7d87b 100644 --- a/man/label_scales.Rd +++ b/man/label_scales.Rd @@ -35,13 +35,13 @@ scale_label_size_continuous( \item{\code{minor_breaks}}{One of: \itemize{ \item \code{NULL} for no minor breaks -\item \code{waiver()} for the default breaks (one minor break between -each major break) +\item \code{waiver()} for the default breaks (none for discrete, one minor break +between each major break for continuous) \item A numeric vector of positions \item A function that given the limits returns a vector of minor breaks. Also accepts rlang \link[rlang:as_function]{lambda} function notation. When the function has two arguments, it will be given the limits and major -breaks. +break positions. }} \item{\code{oob}}{One of: \itemize{ diff --git a/man/scale_divergent.Rd b/man/scale_divergent.Rd index ea1607c5..dcf6a486 100644 --- a/man/scale_divergent.Rd +++ b/man/scale_divergent.Rd @@ -63,13 +63,13 @@ Also accepts rlang \link[rlang:as_function]{lambda} function notation. \item{\code{minor_breaks}}{One of: \itemize{ \item \code{NULL} for no minor breaks -\item \code{waiver()} for the default breaks (one minor break between -each major break) +\item \code{waiver()} for the default breaks (none for discrete, one minor break +between each major break for continuous) \item A numeric vector of positions \item A function that given the limits returns a vector of minor breaks. Also accepts rlang \link[rlang:as_function]{lambda} function notation. When the function has two arguments, it will be given the limits and major -breaks. +break positions. }} \item{\code{n.breaks}}{An integer guiding the number of major breaks. The algorithm may choose a slightly different number to ensure nice break labels. Will