Various polishes

Author: teunbrand

R/coord-.R

@@ -28,7 +28,7 @@
 #'
 #' A constructor function is usually paired with a Coord class. The constructor
 #' copies the coord class and populates parameters. The constructor function name
-#' is formatted by taking the Coord class name and formatting it with snake_case,
+#' should take the Coord class name and be formatted with snake_case,
 #' so that `CoordNew` becomes `coord_new()`.
 #'
 #' @export
@@ -153,7 +153,7 @@ Coord <- ggproto("Coord",
   #' **Arguments**
   #' \describe{
   #'   \item{`layout`}{A data frame computed by `Facet$compute_layout()`.
-  #'   Typically contains the facetting variables, `ROW`, `COL`, `PANEL`,
+  #'   Typically contains the faceting variables, `ROW`, `COL`, `PANEL`,
   #'   `SCALE_X` and `SCALE_Y` variables.}
   #'   \item{`params`}{A list of parameters coming from the `setup_params()`
   #'   method.}

R/geom-.R

@@ -125,7 +125,7 @@ Geom <- ggproto(
   #' **Arguments**
   #' \describe{
   #'   \item{`data`}{A data frame with the layer's data.}
-  #'   \item{`params`}{A list of current parameters}
+  #'   \item{`params`}{A list of current parameters.}
   #' }
   #'
   #' **Value**
@@ -149,7 +149,7 @@ Geom <- ggproto(
   #' \describe{
   #'   \item{`data`}{A data frame with the layer's data.}
   #'   \item{`params`}{A list of parameters coming from the `setup_params()`
-  #'   method}
+  #'   method.}
   #' }
   #'
   #' **Value**
@@ -186,7 +186,7 @@ Geom <- ggproto(
   #'   \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()]}
+  #'   \item{`theme`}{A [completed theme][complete_theme()].}
   #' }
   #'
   #' **Value**
@@ -386,7 +386,9 @@ Geom <- ggproto(
   #'
   #' **Value**
   #'
-  #' A single grob or [`zeroGrob()`] when there is nothing to draw.
+  #' A single grob or [`zeroGrob()`] when there is nothing to draw. For
+  #' `draw_panel()` this can be a [gTree][grid::grob] holding individual grobs
+  #' from the `draw_group()` method.
   draw_panel = function(self, data, panel_params, coord, ...) {
     groups <- split(data, factor(data$group))
     grobs <- lapply(groups, function(group) {

R/guide-.R

@@ -367,7 +367,7 @@ Guide <- ggproto(
   #' **Arguments**
   #' \describe{
   #'   \item{`params`}{A list of parameters initiated by the `params` field.}
-  #'   \item{`coord`}{A list of current parameters}
+  #'   \item{`coord`}{A `<Coord>` ggproto object.}
   #'   \item{`...`}{Optional arguments, typically `panel_params` for most
   #'   position guides.}
   #' }

R/layer.R

@@ -374,6 +374,8 @@ validate_mapping <- function(mapping, call = caller_env()) {
 #' ```
 #' @usage NULL
 #' @format NULL
+#' @examples
+#' # None: Layer is not intended to be extended
 Layer <- ggproto("Layer", NULL,
 
   # Fields ------------------------------------------------------------------

R/stat-.R

@@ -313,7 +313,9 @@ Stat <- ggproto(
     data_new[, !names(data_new) %in% non_constant_columns, drop = FALSE]
   },
 
-  compute_group = not_implemented("compute_group"),
+  compute_group = function(self, data, scales) {
+    cli::cli_abort("Not implemented.")
+  },
 
   # finish_statistics -------------------------------------------------------