From 672287a6152303b61769b28f9947f8f8afa40faf Mon Sep 17 00:00:00 2001 From: Ben Straub Date: Fri, 6 Dec 2024 02:14:52 +0000 Subject: [PATCH] chore: #466 lints and docs --- R/lifecycle_admiral.R | 2 +- man/deprecate_inform.Rd | 5 ++--- tests/testthat/test-lifecycle_admiral.R | 4 ++-- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/R/lifecycle_admiral.R b/R/lifecycle_admiral.R index a13690c1..ce4681c4 100644 --- a/R/lifecycle_admiral.R +++ b/R/lifecycle_admiral.R @@ -9,7 +9,7 @@ #' #' @examples #' # A Phase 1 deprecated function with custom bulleted list: -#' deprecate_warn( +#' deprecate_inform( #' when = "1.0.0", #' what = "foo()", #' details = c( diff --git a/man/deprecate_inform.Rd b/man/deprecate_inform.Rd index 2e753d2b..96c04211 100644 --- a/man/deprecate_inform.Rd +++ b/man/deprecate_inform.Rd @@ -22,12 +22,11 @@ deprecate_warn( when = "1.0.0", what = "foo()", details = c( + # 'x = "This message will turn into a warning with release of x.y.z", i = "See admiral's deprecation guidance: https://pharmaverse.github.io/admiraldev/dev/articles/programming_strategy.html#deprecation" + ) ) -) - - } \concept{messages} diff --git a/tests/testthat/test-lifecycle_admiral.R b/tests/testthat/test-lifecycle_admiral.R index eb3d210d..56897f58 100644 --- a/tests/testthat/test-lifecycle_admiral.R +++ b/tests/testthat/test-lifecycle_admiral.R @@ -23,8 +23,8 @@ test_that("lifecycle_admiral Test 2: Nicer message is sent to user", { details = c( 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" - ) # nolint + https://pharmaverse.github.io/admiraldev/dev/articles/programming_strategy.html#deprecation" # nolint + ) ) assert_data_frame(dataset, required_vars = exprs(STUDYID, USUBJID)) }