Skip to content

Commit

Permalink
docs: #466 news entry for function and some general guidance for refe…
Browse files Browse the repository at this point in the history
…rence page
  • Loading branch information
bms63 committed Nov 15, 2024
1 parent aec78d9 commit 94d4c79
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
5 changes: 5 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
14 changes: 9 additions & 5 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.*
Expand Down

0 comments on commit 94d4c79

Please sign in to comment.