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

Feature Request: Deprecation Function that automates Deprecation Strategy #36

Closed
bms63 opened this issue Aug 8, 2022 · 5 comments
Closed
Labels
enhancement New feature or request programming

Comments

@bms63
Copy link
Collaborator

bms63 commented Aug 8, 2022

Feature Idea

A function that helps to remind us when a function should be removed from the code-base.

Essentially a wrapper function around deprecate_stop, deprecate_warn but also causes the package to be unable to build once the function is no longer kept inside admiral.

Relevant Input

No response

Relevant Output

No response

Reproducible Example/Pseudo Code

No response

@bundfussr
Copy link
Collaborator

Maybe we could even implement an addin which adds the lifecycle badge ("deprecated" for warn and "defunct" for stop) and the standard deprecation text to the roxygen header.

@bms63
Copy link
Collaborator Author

bms63 commented May 8, 2023

This will require a lot of thought around how to do this! Be sure to reach out to discuss before taking this one.

@bms63
Copy link
Collaborator Author

bms63 commented Sep 18, 2023

While our manual process is a bit cumbersome, perhaps automating will prove even more cumbersome and challenging and a waste of effort.

I haven't heard of anyone else doing this in other tidyverse or R packages? @pharmaverse/admiral has anyone seen this? If not, I think we should close this one out.

@ddsjoberg
Copy link
Collaborator

I agree it's best here to stick with the standard manual process. While perhaps cumbersome now, we'll have fewer and fewer deprecations in our future. 🤞🏼

@bms63
Copy link
Collaborator Author

bms63 commented Sep 18, 2023

Going to close - but if folks come up with examples of seeing this in the wild or think it should remain in the backlog feel free to re-open.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request programming
Development

No branches or pull requests

4 participants