Skip to content

Fixing documentation in binned_scale suggesting it defaults to oob = censor #5691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Config/testthat/edition: 3
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.0
RoxygenNote: 7.3.1
Collate:
'ggproto.R'
'ggplot-global.R'
Expand Down
8 changes: 8 additions & 0 deletions R/scale-.R
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,14 @@ discrete_scale <- function(aesthetics, scale_name = deprecated(), palette, name
#' the scale will ask the transformation object to create breaks, and this
#' may result in a different number of breaks than requested. Ignored if
#' breaks are given explicitly.
#' @param oob One of:
#' - Function that handles limits outside of the scale limits
#' (out of bounds). Also accepts rlang [lambda][rlang::as_function()]
#' function notation.
#' - The default ([scales::squish()]) squishes out of
#' bounds values into range.
#' - [scales::censor] for replacing out of bounds values with `NA`.
#' - [scales::squish_infinite()] for squishing infinite values into range.
#' @param right Should the intervals be closed on the right (`TRUE`, default) or
#' should the intervals be closed on the left (`FALSE`)? 'Closed on the right'
#' means that values at break positions are part of the lower bin (open on the
Expand Down
4 changes: 2 additions & 2 deletions man/aes_colour_fill_alpha.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/aes_group_order.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/aes_linetype_size_shape.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/aes_position.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions man/binned_scale.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/position_dodge.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/position_identity.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/position_nudge.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/position_stack.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions man/scale_binned.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 10 additions & 10 deletions man/scale_steps.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.