Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: deprecate_soft and quite deprecation messages #448

Open
bms63 opened this issue Apr 29, 2024 · 1 comment
Open

Documentation: deprecate_soft and quite deprecation messages #448

bms63 opened this issue Apr 29, 2024 · 1 comment

Comments

@bms63
Copy link
Collaborator

bms63 commented Apr 29, 2024

TB updated: But notes should be placed in documentation around these new functions and packages for deprecation.

Should we also have this practice in admiral?

If we want to have it, we should update the "Deprecation" section in the Programming Strategy.

okay there is also this use of deprecate_soft that is nice as well. I will make an issue

Originally posted by @bms63 in #447 (comment)

@ddsjoberg
Copy link
Collaborator

The "official" deprecation process recommended by the tidyverse devs, is to first soft deprecate (aka only message devs about upcoming changes, so they can begin to update their packages so users never know about upstream changes that don't affect them), warning (all users see, and code still works), and finally defunct (function still exported, but errors out).

The soft deprecation is perfect for functions from admiraldev (and potentially skip some of the other steps even), because as the pkg names suggests, these are developer functions.

Regarding adding this strategy for the user-facing functions, I am in favor of adopting the full three-step deprecation process. But would be cautious about using soft deprecations in place of any of the other steps for user-facing functions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants