Start using @inheritDotParams in documentation (#2170)

Closes #2164

* Use @inheritDotParams for geom_polygon params in borders()

* Inherit dot params from cut.default

* Use @inheritDotParams in as.list.ggproto documentation

* Use @inheritDotParams in scale_hue and scale_grey

* Use @inheritDotParams for scale_*_gradient

* Use @inheritDotParams for scale_*_discrete as well as scale_linetype,
scale_shape, and scale_manual

* Use @inheritDotParams for scale_size_area

* Fix typo

Author: karawoo

R/fortify-map.r

@@ -86,7 +86,7 @@ map_data <- function(map, region = ".", exact = FALSE, ...) {
 #' @param colour border colour
 #' @param xlim,ylim latitudinal and logitudinal range for extracting map
 #'   polygons, see [maps::map()] for details.
-#' @param ... other arguments passed onto [geom_polygon()]
+#' @inheritDotParams geom_polygon
 #' @export
 #' @examples
 #' if (require("maps")) {

R/ggproto.r

@@ -193,7 +193,7 @@ make_proto_method <- function(self, f) {
 #' @param x A ggproto object to convert to a list.
 #' @param inherit If `TRUE` (the default), flatten all inherited items into
 #'   the returned list. If `FALSE`, do not include any inherited items.
-#' @param ... Further arguments to pass to `as.list.environment`.
+#' @inheritDotParams base::as.list.environment -x
 #' @export
 #' @keywords internal
 as.list.ggproto <- function(x, inherit = TRUE, ...) {

R/scale-discrete-.r

@@ -6,9 +6,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.
 #'
-#' @param ... common discrete scale parameters: `name`, `breaks`,
-#'  `labels`, `na.value`, `limits` and `guide`.  See
-#'  [discrete_scale()] for more details
+#' @inheritDotParams discrete_scale -expand -position
 #' @param expand a numeric vector of length two giving multiplicative and
 #'   additive expansion constants. These constants ensure that the data is
 #'   placed some distance away from the axes.

R/scale-gradient.r

@@ -15,8 +15,7 @@
 #' @param low,high Colours for low and high ends of the gradient.
 #' @param guide Type of legend. Use `"colourbar"` for continuous
 #'   colour bar, or `"legend"` for discrete colour legend.
-#' @param ... Other arguments passed on to [continuous_scale()]
-#'   to control name, limits, breaks, labels and so forth.
+#' @inheritDotParams continuous_scale -na.value -guide
 #' @seealso [scales::seq_gradient_pal()] for details on underlying
 #'   palette
 #' @family colour scales

R/scale-grey.r

@@ -5,6 +5,7 @@
 #'
 #' @inheritParams scales::grey_pal
 #' @inheritParams scale_colour_hue
+#' @inheritDotParams discrete_scale
 #' @family colour scales
 #' @rdname scale_grey
 #' @export

R/scale-hue.r

@@ -5,8 +5,7 @@
 #' colour-blind safe palettes.
 #'
 #' @param na.value Colour to use for missing values
-#' @param ... Other arguments passed on to [discrete_scale()]
-#'   to control name, limits, breaks, labels and so forth.
+#' @inheritDotParams discrete_scale
 #' @inheritParams scales::hue_pal
 #' @rdname scale_hue
 #' @export

R/scale-linetype.r

@@ -5,6 +5,7 @@
 #' line types.
 #'
 #' @inheritParams scale_x_discrete
+#' @inheritDotParams discrete_scale -expand -position -na.value
 #' @param na.value The linetype to use for `NA` values.
 #' @rdname scale_linetype
 #' @export

R/scale-manual.r

@@ -4,6 +4,7 @@
 #' data to aesthetic values.
 #'
 #' @inheritParams scale_x_discrete
+#' @inheritDotParams discrete_scale -expand -position
 #' @param values a set of aesthetic values to map data values to. If this
 #'   is a named vector, then the values will be matched based on the names.
 #'   If unnamed, values will be matched in order (usually alphabetical) with

R/scale-shape.r

@@ -9,6 +9,7 @@
 #' @param solid Should the shapes be solid, `TRUE`, or hollow,
 #'   `FALSE`?
 #' @inheritParams scale_x_discrete
+#' @inheritDotParams discrete_scale -expand -position
 #' @rdname scale_shape
 #' @export
 #' @examples

R/scale-size.r

@@ -67,8 +67,7 @@ scale_size_discrete <- function(..., range = c(2, 6)) {
   }, ...)
 }
 
-#' @param ... Other arguments passed on to [continuous_scale()]
-#'   to control name, limits, breaks, labels and so forth.
+#' @inheritDotParams continuous_scale -aesthetics -scale_name -palette -rescaler
 #' @param max_size Size of largest points.
 #' @export
 #' @rdname scale_size