From 94d4c79ae3dd00c695be927e22033abb3cc20113 Mon Sep 17 00:00:00 2001 From: Ben Straub Date: Fri, 15 Nov 2024 23:20:40 +0000 Subject: [PATCH] docs: #466 news entry for function and some general guidance for reference page --- NEWS.md | 5 +++++ _pkgdown.yml | 14 +++++++++----- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/NEWS.md b/NEWS.md index 0c2762f9..d4b0367d 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,5 +1,10 @@ # admiraldev (development version) +## New Features + +- New Function `deprecate_inform()` is a wrapper around + `lifecycle::deprecate_soft()` to allow for more control over messaging. (#466) + ## Updates of Existing Functions - Objects passed to `assert_list_element()` via the `...` argument can now be diff --git a/_pkgdown.yml b/_pkgdown.yml index 30d3cd76..3ef8e3a2 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -91,12 +91,16 @@ reference: - title: Deprecated desc: | - As `{admiral}` is still evolving, functions/arguments may need to be removed or replaced over time. In such cases, the function/argument will enter a 3 year deprecation cycle: + As `{admiral}` is still evolving, functions/arguments may need to be removed or replaced over time. + In such cases, the function/argument will enter a 3 year deprecation cycle. The cycle + will be tied as close as sensibly possible to a release. - * In the first release (1 year), there will be a message issued if you use the function/argument, but it will still be available to use. - * In the following release (1 year), an warning will be produced if you use the function/argument. - * In the following release (1 year), an error will be produced if you use the function/argument. - * Finally, after 3 years onwards, the function/argument will be removed from `{admiral}` and its documentation completely. + Once a function is deprecated: + + * In Year 1 there will be a message issued if you use the function/argument, but it will still be available to use. + * In Year 2 a warning will be produced if you use the function/argument. + * In Year 3, an error will be produced if you use the function/argument. + * Finally, after 3 years, the function/argument and related documentation and tests will be removed from `{admiral}`. *Note: Guidance on replacement functionality can be found in the warning/error message produced or in the function's documentation.*