Fix #399 - imporve documentation

r-lib · Oct 31, 2023 · b8c577e · b8c577e
1 parent c0ef74c
commit b8c577e
Show file tree

Hide file tree

Showing 66 changed files with 236 additions and 64 deletions.
diff --git a/R/label-bytes.R b/R/label-bytes.R
@@ -13,7 +13,7 @@
 #'   * `auto_si` or `auto_binary` to automatically pick the most appropriate
 #'     unit for each value.
 #' @inheritParams number_format
-#' @param ... Other arguments passed on to [number()]
+#' @inheritDotParams number
 #' @return A labeller function that takes a numeric vector of breaks and
 #'   returns a character vector of labels.
 #' @export

diff --git a/R/label-dollar.R b/R/label-dollar.R
@@ -11,7 +11,7 @@
 #' @param prefix,suffix Symbols to display before and after value.
 #' @param negative_parens `r lifecycle::badge("deprecated")` Use
 #'   `style_negative = "parens"` instead.
-#' @param ... Other arguments passed on to [base::format()].
+#' @inheritDotParams number
 #' @export
 #' @family labels for continuous scales
 #' @examples

diff --git a/R/label-number-si.R b/R/label-number-si.R
@@ -15,6 +15,7 @@
 #' @param scale A scaling factor: `x` will be multiplied by `scale` before
 #'   formatting. This is useful if the underlying data is already using an SI
 #'   prefix.
+#' @inheritDotParams label_number
 #' @export
 #' @family labels for continuous scales
 #' @family labels for log scales

diff --git a/R/label-ordinal.R b/R/label-ordinal.R
@@ -9,7 +9,7 @@
 #'   Name gives suffix, and value specifies which numbers to match.
 #' @param gender Masculin or feminin gender for French ordinal.
 #' @param plural Plural or singular for French ordinal.
-#' @param ... Other arguments passed on to [base::format()].
+#' @inheritDotParams number
 #' @export
 #' @family labels for continuous scales
 #' @examples

diff --git a/R/label-percent.R b/R/label-percent.R
@@ -1,6 +1,7 @@
 #' Label percentages (2.5%, 50%, etc)
 #'
 #' @inherit label_number return params
+#' @inheritDotParams label_number
 #' @export
 #' @family labels for continuous scales
 #' @examples

diff --git a/man/Range.Rd b/man/Range.Rd
diff --git a/man/alpha.Rd b/man/alpha.Rd
diff --git a/man/area_pal.Rd b/man/area_pal.Rd
diff --git a/man/asn_trans.Rd b/man/asn_trans.Rd
diff --git a/man/atanh_trans.Rd b/man/atanh_trans.Rd
diff --git a/man/boxcox_trans.Rd b/man/boxcox_trans.Rd
diff --git a/man/breaks_extended.Rd b/man/breaks_extended.Rd
diff --git a/man/breaks_pretty.Rd b/man/breaks_pretty.Rd
diff --git a/man/breaks_width.Rd b/man/breaks_width.Rd
diff --git a/man/brewer_pal.Rd b/man/brewer_pal.Rd
diff --git a/man/col2hcl.Rd b/man/col2hcl.Rd
diff --git a/man/col_numeric.Rd b/man/col_numeric.Rd
diff --git a/man/comma.Rd b/man/comma.Rd
diff --git a/man/cscale.Rd b/man/cscale.Rd
diff --git a/man/date_trans.Rd b/man/date_trans.Rd
diff --git a/man/demo_continuous.Rd b/man/demo_continuous.Rd
diff --git a/man/dichromat_pal.Rd b/man/dichromat_pal.Rd
diff --git a/man/div_gradient_pal.Rd b/man/div_gradient_pal.Rd
diff --git a/man/dscale.Rd b/man/dscale.Rd
diff --git a/man/exp_trans.Rd b/man/exp_trans.Rd
diff --git a/man/expand_range.Rd b/man/expand_range.Rd
diff --git a/man/fullseq.Rd b/man/fullseq.Rd
diff --git a/man/gradient_n_pal.Rd b/man/gradient_n_pal.Rd
diff --git a/man/grey_pal.Rd b/man/grey_pal.Rd
diff --git a/man/hms_trans.Rd b/man/hms_trans.Rd
diff --git a/man/hue_pal.Rd b/man/hue_pal.Rd
diff --git a/man/identity_pal.Rd b/man/identity_pal.Rd
diff --git a/man/identity_trans.Rd b/man/identity_trans.Rd
diff --git a/man/label_bytes.Rd b/man/label_bytes.Rd
diff --git a/man/label_dollar.Rd b/man/label_dollar.Rd
diff --git a/man/label_number.Rd b/man/label_number.Rd
diff --git a/man/label_number_si.Rd b/man/label_number_si.Rd