rename check_number_decimal to check_number

Author: khusmann

R/standalone-types-check.R

@@ -1,14 +1,17 @@
 # ---
 # repo: r-lib/rlang
 # file: standalone-types-check.R
-# last-updated: 2023-03-13
+# last-updated: 2025-09-19
 # license: https://unlicense.org
 # dependencies: standalone-obj-type.R
 # imports: rlang (>= 1.1.0)
 # ---
 #
 # ## Changelog
 #
+# 2025-09-19:
+# - Rename `check_number_decimal()` to `check_number()` (@khusmann, #1714)
+#
 # 2024-08-15:
 # - `check_character()` gains an `allow_na` argument (@martaalcalde, #1724)
 #
@@ -175,7 +178,7 @@ IS_NUMBER_true <- 0
 IS_NUMBER_false <- 1
 IS_NUMBER_oob <- 2
 
-check_number_decimal <- function(
+check_number <- function(
   x,
   ...,
   min = NULL,

tests/testthat/_snaps/standalone-types-check.md

@@ -244,76 +244,76 @@
       Error in `check()`:
       ! `max` must be a number, not missing.
 
-# `check_number_decimal()` checks
+# `check_number()` checks
 
     Code
-      err(checker(, check_number_decimal))
+      err(checker(, check_number))
     Output
       <error/rlang_error>
       Error in `checker()`:
       ! `foo` must be a number, not absent.
     Code
-      err(checker(NA, check_number_decimal))
+      err(checker(NA, check_number))
     Output
       <error/rlang_error>
       Error in `checker()`:
       ! `foo` must be a number, not `NA`.
     Code
-      err(checker(NULL, check_number_decimal))
+      err(checker(NULL, check_number))
     Output
       <error/rlang_error>
       Error in `checker()`:
       ! `foo` must be a number, not `NULL`.
     Code
-      err(checker(int(), check_number_decimal, allow_na = TRUE))
+      err(checker(int(), check_number, allow_na = TRUE))
     Output
       <error/rlang_error>
       Error in `checker()`:
       ! `foo` must be a number or `NA`, not an empty integer vector.
     Code
-      err(checker(na_dbl, check_number_decimal))
+      err(checker(na_dbl, check_number))
     Output
       <error/rlang_error>
       Error in `checker()`:
       ! `foo` must be a number, not a numeric `NA`.
     Code
-      err(checker(na_int, check_number_decimal))
+      err(checker(na_int, check_number))
     Output
       <error/rlang_error>
       Error in `checker()`:
       ! `foo` must be a number, not an integer `NA`.
     Code
-      err(checker(10:11, check_number_decimal, allow_na = TRUE, allow_null = TRUE))
+      err(checker(10:11, check_number, allow_na = TRUE, allow_null = TRUE))
     Output
       <error/rlang_error>
       Error in `checker()`:
       ! `foo` must be a number, `NA`, or `NULL`, not an integer vector.
     Code
-      err(checker(Inf, check_number_decimal, allow_infinite = FALSE))
+      err(checker(Inf, check_number, allow_infinite = FALSE))
     Output
       <error/rlang_error>
       Error in `checker()`:
       ! `foo` must be a number, not `Inf`.
     Code
-      err(checker(-Inf, check_number_decimal, allow_infinite = FALSE))
+      err(checker(-Inf, check_number, allow_infinite = FALSE))
     Output
       <error/rlang_error>
       Error in `checker()`:
       ! `foo` must be a number, not `-Inf`.
     Code
-      err(checker(10, min = NA, check_number_decimal))
+      err(checker(10, min = NA, check_number))
     Output
       <error/rlang_error>
       Error in `check()`:
       ! `min` must be a single double value.
     Code
-      err(checker(10, min = NaN, check_number_decimal))
+      err(checker(10, min = NaN, check_number))
     Output
       <error/rlang_error>
       Error in `check()`:
       ! `min` must be a number, not missing.
     Code
-      err(checker(10, max = NaN, check_number_decimal))
+      err(checker(10, max = NaN, check_number))
     Output
       <error/rlang_error>
       Error in `check()`:
@@ -499,7 +499,7 @@
       Error:
       ! `factor("a")` must be a whole number, not a <factor> object.
     Code
-      (expect_error(check_number_decimal(as.Date("2000-01-01"))))
+      (expect_error(check_number(as.Date("2000-01-01"))))
     Output
       <error/rlang_error>
       Error:

tests/testthat/test-standalone-types-check.R

@@ -84,35 +84,35 @@ test_that("`check_number_whole()` checks", {
   })
 })
 
-test_that("`check_number_decimal()` checks", {
-  expect_null(check_number_decimal(10))
-  expect_null(check_number_decimal(10L))
-  expect_null(check_number_decimal(10.5))
-  expect_null(check_number_decimal(NA, allow_na = TRUE))
-  expect_null(check_number_decimal(na_dbl, allow_na = TRUE))
-  expect_null(check_number_decimal(na_int, allow_na = TRUE))
-  expect_null(check_number_decimal(NULL, allow_null = TRUE))
-  expect_null(check_number_decimal(Inf))
-  expect_null(check_number_decimal(-Inf))
+test_that("`check_number()` checks", {
+  expect_null(check_number(10))
+  expect_null(check_number(10L))
+  expect_null(check_number(10.5))
+  expect_null(check_number(NA, allow_na = TRUE))
+  expect_null(check_number(na_dbl, allow_na = TRUE))
+  expect_null(check_number(na_int, allow_na = TRUE))
+  expect_null(check_number(NULL, allow_null = TRUE))
+  expect_null(check_number(Inf))
+  expect_null(check_number(-Inf))
 
   expect_snapshot({
-    err(checker(, check_number_decimal))
-    err(checker(NA, check_number_decimal))
-    err(checker(NULL, check_number_decimal))
-    err(checker(int(), check_number_decimal, allow_na = TRUE))
-    err(checker(na_dbl, check_number_decimal))
-    err(checker(na_int, check_number_decimal))
+    err(checker(, check_number))
+    err(checker(NA, check_number))
+    err(checker(NULL, check_number))
+    err(checker(int(), check_number, allow_na = TRUE))
+    err(checker(na_dbl, check_number))
+    err(checker(na_int, check_number))
     err(checker(
       10:11,
-      check_number_decimal,
+      check_number,
       allow_na = TRUE,
       allow_null = TRUE
     ))
-    err(checker(Inf, check_number_decimal, allow_infinite = FALSE))
-    err(checker(-Inf, check_number_decimal, allow_infinite = FALSE))
-    err(checker(10, min = NA, check_number_decimal))
-    err(checker(10, min = NaN, check_number_decimal))
-    err(checker(10, max = NaN, check_number_decimal))
+    err(checker(Inf, check_number, allow_infinite = FALSE))
+    err(checker(-Inf, check_number, allow_infinite = FALSE))
+    err(checker(10, min = NA, check_number))
+    err(checker(10, min = NaN, check_number))
+    err(checker(10, max = NaN, check_number))
   })
 })
 
@@ -194,7 +194,7 @@ test_that("`check_logical()` checks", {
 test_that("non-numeric types are not numbers", {
   expect_snapshot({
     (expect_error(check_number_whole(factor("a"))))
-    (expect_error(check_number_decimal(as.Date("2000-01-01"))))
+    (expect_error(check_number(as.Date("2000-01-01"))))
   })
 })