polish

Author: teunbrand

R/geom-.R

@@ -39,12 +39,7 @@ NULL
 #'
 #' @export
 #' @format NULL
-#' @usage
-#' # Creating a new subclass
-#' GeomNew <- ggproto("GeomNew", Geom, ...)
-#'
-#' # Usage in the `layer()` function
-#' layer(geom = GeomNew, ...)
+#' @usage NULL
 #' @seealso The `r link_book("new geoms section", "extensions#sec-new-geoms")`
 #' @seealso Run `vignette("extending-ggplot2")`, in particular the "Creating a
 #' new geom" section.
@@ -188,11 +183,10 @@ Geom <- ggproto(
   #'   \item{`data`}{A data frame of the layer's data, coming from the
   #'   `setup_data()` method. Can be `NULL`, in which case resolved defaults
   #'   should be returned.}
-  #'   \item{`params`}{A list of layer parameters, coming from the
-  #'   `setup_params()` method}
-  #'   \item{`modifiers`}{A [mapping][`aes()`] with delayed evaluations.}
-  #'   \item{`default_aes`}{A [mapping][`aes()`] with default aesthetics.}
-  #'   \item{`theme`}{A [completed theme][`complete_theme()`]}
+  #'   \item{`params`}{A list of fixed aesthetic parameters}
+  #'   \item{`modifiers`}{A [mapping][aes()] with delayed evaluations.}
+  #'   \item{`default_aes`}{A [mapping][aes()] with default aesthetics.}
+  #'   \item{`theme`}{A [completed theme][complete_theme()]}
   #' }
   #'
   #' **Value**
@@ -385,7 +379,7 @@ Geom <- ggproto(
   #'   `coord$transform(data, panel_params)`. When working with non-linear
   #'   coordinate systems, data should be converted to fit a primitive geom
   #'   (e.g. point, path or polygon) and passed on to the corresponding draw
-  #'   method for [munching][`coord_munch()`].}
+  #'   method for [munching][coord_munch()].}
   #'   \item{`...`}{Reserved for extensions. By default, this is passed on to
   #'   the `draw_group()` method.}
   #' }

R/position-.R

@@ -31,12 +31,7 @@
 #'
 #' @export
 #' @format NULL
-#' @usage
-#' # Creating new subclass
-#' PositionNew <- ggproto("PositionNew", Position, ...)
-#'
-#' # Usage in the `layer()` function
-#' layer(position = PositionNew)
+#' @usage NULL
 #' @seealso The `r link_book("new positions section", "extensions#new-positions")`
 #' @examples
 #' # Extending the class

R/stat-.R

@@ -27,18 +27,13 @@
 #' prefix, like `StatNew`.
 #'
 #' A constructor function is usually paired wih a Stat class. The constructor
-#' wraps a call t o `layer()`, where e.g. `layer(stat = StatNew)`. The
+#' wraps a call to `layer()`, where e.g. `layer(stat = StatNew)`. The
 #' constructor function name is formatted by taking the Stat class name and
 #' formatting it with snake_case, so that `StatNew` becomes `stat_new()`.
 #'
 #' @export
 #' @format NULL
-#' @usage
-#' # Creating a new subclass
-#' StatNew <- ggproto("StatNew", Stat, ...)
-#'
-#' # Usage in the `layer()` function
-#' layer(stat = StatNew)
+#' @usage NULL
 #' @seealso The `r link_book("new stats section", "extensions#sec-new-stats")`.
 #' @seealso Run `vignette("extending-ggplot2")`, in particular the "Creating a
 #' new stat" section.
@@ -243,9 +238,9 @@ Stat <- ggproto(
   #' **Arguments**
   #' \describe{
   #'   \item{`data`}{A data frame with the layer's data.}
-  #'   \item{`scales`}{A list containing pre-trained `x` and `y` scales.
-  #'   Note that these are global scales trained on all data, not panel-specific
-  #'   scales.}
+  #'   \item{`scales`}{A list of pre-trained `x` and `y` scales. Note that the
+  #'   position scales are not finalised at this point and reflect the initial
+  #'   data range before computing stats.}
   #'   \item{`...`}{Reserved for extensions. By default, this passes parameters
   #'   to the `compute_group()` method.}
   #' }