Skip to content

Commit 12d1c98

Browse files
authored
Document guide theme argument (#6268)
* mention ignored arguments * No need to fuss over these specifics with axes * document
1 parent f8d9825 commit 12d1c98

11 files changed

+37
-10
lines changed

R/guide-axis.R

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
#' [scale_(x|y)_discrete()][scale_x_discrete()].
77
#'
88
#' @inheritParams guide_legend
9+
#' @param theme A [`theme`][theme()] object to style the guide individually or
10+
#' differently from the plot's theme settings. The `theme` argument in the
11+
#' guide partially overrides, and is combined with, the plot's theme.
912
#' @param check.overlap silently remove overlapping labels,
1013
#' (recursively) prioritizing the first, last, and middle labels.
1114
#' @param angle Compared to setting the angle in [theme()] / [element_text()],

R/guide-legend.R

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,11 @@
1515
#' specified in [labs()] is used for the title.
1616
#' @param theme A [`theme`][theme()] object to style the guide individually or
1717
#' differently from the plot's theme settings. The `theme` argument in the
18-
#' guide overrides, and is combined with, the plot's theme.
18+
#' guide partially overrides, and is combined with, the plot's theme.
19+
#' Arguments that apply to a single legend are respected, most of which have
20+
#' the `legend`-prefix. Arguments that apply to combined legends
21+
#' (the legend box) are ignored, including `legend.position`,
22+
#' `legend.justification.*`, `legend.location` and `legend.box.*`.
1923
#' @param position A character string indicating where the legend should be
2024
#' placed relative to the plot panels.
2125
#' @param direction A character string indicating the direction of the guide.

man/guide_axis.Rd

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

man/guide_axis_logticks.Rd

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

man/guide_axis_stack.Rd

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

man/guide_axis_theta.Rd

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

man/guide_bins.Rd

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

man/guide_colourbar.Rd

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

man/guide_coloursteps.Rd

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

man/guide_custom.Rd

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

man/guide_legend.Rd

Lines changed: 5 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)