Review error messages (#5557)

* Add full stops to error messages.

* Remove self-ref

* Replace `expect_snapshot_warning` and `expect_snapshot_error()` with `expect_snapshot()`.

* Review and accept snapshots

* error msg

* style

* typo

* Revert "Replace `expect_snapshot_warning` and `expect_snapshot_error()` with `expect_snapshot()`."

This reverts commit 3b7dcc7.

* change

* Update snapshots

* Adjust failing tests

* Apply suggestions from code review

Co-authored-by: Teun van den Brand <49372158+teunbrand@users.noreply.github.com>

* Apply suggestions from teunbrand

---------

Co-authored-by: Teun van den Brand <49372158+teunbrand@users.noreply.github.com>

Author: olivroy

R/aes.R

@@ -425,7 +425,7 @@ alternative_aes_extract_usage <- function(x) {
   } else if (is_call(x, "$")) {
     as.character(x[[3]])
   } else {
-    cli::cli_abort("Don't know how to get alternative usage for {.var {x}}")
+    cli::cli_abort("Don't know how to get alternative usage for {.var {x}}.")
   }
 }
 

R/annotation-custom.R

@@ -71,7 +71,7 @@ GeomCustomAnn <- ggproto("GeomCustomAnn", Geom,
   draw_panel = function(data, panel_params, coord, grob, xmin, xmax,
                         ymin, ymax) {
     if (!inherits(coord, "CoordCartesian")) {
-      cli::cli_abort("{.fn annotation_custom} only works with {.fn coord_cartesian}")
+      cli::cli_abort("{.fn annotation_custom} only works with {.fn coord_cartesian}.")
     }
     corners <- data_frame0(
       x = c(xmin, xmax),

R/annotation-map.R

@@ -63,7 +63,7 @@ annotation_map <- function(map, ...) {
   if (!is.null(map$long)) map$x <- map$long
   if (!is.null(map$region)) map$id <- map$region
   if (!all(c("x", "y", "id") %in% names(map))) {
-    cli::cli_abort("{.arg map} must have the columns {.col x}, {.col y}, and {.col id}")
+    cli::cli_abort("{.arg map} must have the columns {.col x}, {.col y}, and {.col id}.")
   }
 
   layer(

R/annotation-raster.R

@@ -74,7 +74,7 @@ GeomRasterAnn <- ggproto("GeomRasterAnn", Geom,
   draw_panel = function(data, panel_params, coord, raster, xmin, xmax,
                         ymin, ymax, interpolate = FALSE) {
     if (!inherits(coord, "CoordCartesian")) {
-      cli::cli_abort("{.fn annotation_raster} only works with {.fn coord_cartesian}")
+      cli::cli_abort("{.fn annotation_raster} only works with {.fn coord_cartesian}.")
     }
     corners <- data_frame0(
       x = c(xmin, xmax),

R/annotation.R

@@ -13,7 +13,7 @@
 #'
 #' @section Unsupported geoms:
 #' Due to their special nature, reference line geoms [geom_abline()],
-#' [geom_hline()], and [geom_vline()] can't be used with [annotate()].
+#' [geom_hline()], and [geom_vline()] can't be used with `annotate()`.
 #' You can use these geoms directly for annotations.
 #' @param geom name of geom to use for annotation
 #' @param x,y,xmin,ymin,xmax,ymax,xend,yend positioning aesthetics -

R/autolayer.R

@@ -15,5 +15,5 @@ autolayer <- function(object, ...) {
 
 #' @export
 autolayer.default <- function(object, ...) {
-  cli::cli_abort("No autolayer method available for {.cls {class(object)[1]}} objects")
+  cli::cli_abort("No autolayer method available for {.cls {class(object)[1]}} objects.")
 }

R/autoplot.R

@@ -17,7 +17,7 @@ autoplot <- function(object, ...) {
 autoplot.default <- function(object, ...) {
   cli::cli_abort(c(
     "Objects of class {.cls {class(object)[[1]]}} are not supported by autoplot.",
-    "i" = "have you loaded the required package?"
+    "i" = "Have you loaded the required package?"
   ))
 }
 

R/axis-secondary.R

@@ -123,7 +123,7 @@ set_sec_axis <- function(sec.axis, scale) {
   if (!is.waive(sec.axis)) {
     if (is.formula(sec.axis)) sec.axis <- sec_axis(sec.axis)
     if (!is.sec_axis(sec.axis)) {
-      cli::cli_abort("Secondary axes must be specified using {.fn sec_axis}")
+      cli::cli_abort("Secondary axes must be specified using {.fn sec_axis}.")
     }
     scale$secondary.axis <- sec.axis
   }
@@ -165,7 +165,7 @@ AxisSecondary <- ggproto("AxisSecondary", NULL,
       return()
     }
     if (!is.function(self$trans)) {
-      cli::cli_abort("Transformation for secondary axes must be a function")
+      cli::cli_abort("Transformation for secondary axes must be a function.")
     }
     if (is.derived(self$name) && !is.waive(scale$name)) self$name <- scale$name
     if (is.derived(self$breaks)) self$breaks <- scale$breaks
@@ -194,7 +194,7 @@ AxisSecondary <- ggproto("AxisSecondary", NULL,
 
     # Test for monotonicity
     if (!is_unique(sign(diff(full_range))))
-      cli::cli_abort("Transformation for secondary axes must be monotonic")
+      cli::cli_abort("Transformation for secondary axes must be monotonic.")
   },
 
   break_info = function(self, range, scale) {

R/bin.R

@@ -51,13 +51,11 @@ bin_breaks <- function(breaks, closed = c("right", "left")) {
 bin_breaks_width <- function(x_range, width = NULL, center = NULL,
                              boundary = NULL, closed = c("right", "left")) {
   if (length(x_range) != 2) {
-    cli::cli_abort("{.arg x_range} must have two elements")
+    cli::cli_abort("{.arg x_range} must have two elements.")
   }
 
-  check_number_decimal(width)
-  if (width <= 0) {
-    cli::cli_abort("{.arg binwidth} must be positive")
-  }
+  # binwidth seems to be the argument name supplied to width. (stat-bin and stat-bindot)
+  check_number_decimal(width, min = 0, allow_infinite = FALSE, arg = "binwidth")
 
   if (!is.null(boundary) && !is.null(center)) {
     cli::cli_abort("Only one of {.arg boundary} and {.arg center} may be specified.")
@@ -105,7 +103,7 @@ bin_breaks_width <- function(x_range, width = NULL, center = NULL,
 bin_breaks_bins <- function(x_range, bins = 30, center = NULL,
                             boundary = NULL, closed = c("right", "left")) {
   if (length(x_range) != 2) {
-    cli::cli_abort("{.arg x_range} must have two elements")
+    cli::cli_abort("{.arg x_range} must have two elements.")
   }
 
   check_number_whole(bins, min = 1)

R/compat-plyr.R

@@ -19,7 +19,7 @@ unrowname <- function(x) {
   } else if (is.matrix(x)) {
     dimnames(x)[1] <- list(NULL)
   } else {
-    cli::cli_abort("Can only remove rownames from {.cls data.frame} and {.cls matrix} objects")
+    cli::cli_abort("Can only remove rownames from {.cls data.frame} and {.cls matrix} objects.")
   }
   x
 }
@@ -239,7 +239,7 @@ as.quoted <- function(x, env = parent.frame()) {
   } else if (is.call(x)) {
     as.list(x)[-1]
   } else {
-    cli::cli_abort("Must be a character vector, call, or formula")
+    cli::cli_abort("Must be a character vector, call, or formula.")
   }
   attributes(x) <- list(env = env, class = 'quoted')
   x