docs: #466 getting pretty; environment tweaks

pharmaverse · Dec 22, 2024 · e29b860 · e29b860
1 parent 9afde36
commit e29b860
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 10 deletions.
diff --git a/R/lifecycle_admiral.R b/R/lifecycle_admiral.R
@@ -34,8 +34,8 @@ deprecate_inform <- function(
     with = NULL,
     details = NULL,
     id = NULL,
-    env = caller_env(),
-    user_env = caller_env(2)) {
+    env = rlang::caller_env(),
+    user_env = rlang::caller_env(2)) {
   tryCatch(
     lifecycle::deprecate_soft(
       when = when,
@@ -44,7 +44,8 @@ deprecate_inform <- function(
       details = details,
       id = id,
       env = env,
-      user_env = user_env),
+      user_env = user_env
+    ),
     warning = \(w) {
       message(conditionMessage(w))
       tryInvokeRestart("muffleWarning")

diff --git a/man/deprecate_inform.Rd b/man/deprecate_inform.Rd
diff --git a/tests/testthat/_snaps/lifecycle_admiral.md b/tests/testthat/_snaps/lifecycle_admiral.md
@@ -3,27 +3,27 @@
     Code
       example_fun(data)
     Message
-      `example_fun()` was deprecated in <NA> 1.0.0.
+      `example_fun()` was deprecated in admiraldev 1.0.0.
       i Please use `example_fun2()` instead.
     Code
       example_fun(data)
     Message
-      `example_fun()` was deprecated in <NA> 1.0.0.
+      `example_fun()` was deprecated in admiraldev 1.0.0.
       i Please use `example_fun2()` instead.
 
 # lifecycle_admiral Test 2:  Spicier message is sent to user
 
     Code
       example_fun(data)
     Message
-      `example_fun()` was deprecated in <NA> 1.0.0.
+      `example_fun()` was deprecated in admiraldev 1.0.0.
       i Please use `example_fun2()` instead.
       x This message will turn into a warning with release of 1.1.0
       i See admiral's deprecation guidance: https://pharmaverse.github.io/admiraldev/dev/articles/programming_strategy.html#deprecation
     Code
       example_fun(data)
     Message
-      `example_fun()` was deprecated in <NA> 1.0.0.
+      `example_fun()` was deprecated in admiraldev 1.0.0.
       i Please use `example_fun2()` instead.
       x This message will turn into a warning with release of 1.1.0
       i See admiral's deprecation guidance: https://pharmaverse.github.io/admiraldev/dev/articles/programming_strategy.html#deprecation

diff --git a/tests/testthat/test-lifecycle_admiral.R b/tests/testthat/test-lifecycle_admiral.R
@@ -5,7 +5,7 @@ test_that("lifecycle_admiral Test 1:  Simple message is sent to user", {
       when = "1.0.0",
       what = "example_fun()",
       with = "example_fun2()"
-      )
+    )
     assert_data_frame(dataset, required_vars = exprs(STUDYID, USUBJID))
   }