Skip to content

Soft-deprecate surv_reg() #454

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

Merged
merged 7 commits into from
Mar 30, 2021
Merged

Soft-deprecate surv_reg() #454

merged 7 commits into from
Mar 30, 2021

Conversation

hfrick
Copy link
Member

@hfrick hfrick commented Mar 23, 2021

Closes #448

  • A warning is issued by lifecycle::deprecate_soft(), i.e., the "function only warns (a) users who try the feature from the global environment and (b) developers who directly use the feature (when running testthat tests). There is no warning when the deprecated feature is called indirectly by another package — the goal is to ensure that warn only the person who has the power to stop using the deprecated feature."
  • The documentation gets a deprecated badge plus comment and is removed from the documentation index. Existing users can still find it (and see that it's deprecated) but new users will be more likely to find survival_reg()
  • There is a new test for the deprecation warning while the remaining tests skip the warning as not to clutter the output so much.

@hfrick hfrick marked this pull request as draft March 23, 2021 18:54
@hfrick hfrick marked this pull request as ready for review March 24, 2021 11:08
@hfrick hfrick requested a review from topepo March 24, 2021 11:08
@hfrick hfrick merged commit 8238826 into master Mar 30, 2021
@hfrick hfrick deleted the soft-deprecate-surv_reg branch March 30, 2021 08:59
@github-actions
Copy link

This pull request has been automatically locked. If you believe you have found a related problem, please file a new issue (with a reprex: https://reprex.tidyverse.org) and link to this issue.

@github-actions github-actions bot locked and limited conversation to collaborators Apr 14, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Soft-deprecate surv_reg()
2 participants