Skip to content

Commit

Permalink
chore: #466 pkgdown yml
Browse files Browse the repository at this point in the history
  • Loading branch information
bms63 committed Oct 8, 2024
1 parent a78fc84 commit ead0e13
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,12 @@ 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 the following 6-month 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:
* In the first release (0-3 months), there will be a warning issued if you use the function/argument, but it will still be available to use.
* In the following release (3-6 months), an error will be produced if you use the function/argument.
* Finally, from the 3rd release (6 months) onwards, the function/argument will be removed from `{admiral}` and its documentation completely.
* 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.
*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 ead0e13

Please sign in to comment.