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

General Issue: Move deprecated arguments and functions to next phase or remove #2487

Closed
6 tasks
bms63 opened this issue Aug 1, 2024 · 6 comments · Fixed by #2500
Closed
6 tasks

General Issue: Move deprecated arguments and functions to next phase or remove #2487

bms63 opened this issue Aug 1, 2024 · 6 comments · Fixed by #2500
Assignees

Comments

@bms63
Copy link
Collaborator

bms63 commented Aug 1, 2024

Background Information

These function arguments should be further deprecated or removed

image

Please follow this guidance when deprecating https://pharmaverse.github.io/admiraldev/dev/articles/programming_strategy.html#deprecation

Definition of Done

  • Functions or arguments being removed should be documented in the changelog
  • Function or arguments being removed based on their phase of deprecation should also be documented
    • Bonus points if you split them up as Phase 1, 2, 3 so easier to track!
  • Be sure functions/argument documents are appropriately updated and/or removed
  • Be sure unit tests appropriately capture deprecation where appropriate
  • Remove any old deprecation unit tests no longer relevant

@pharmaverse/admiral @pharmaverse/admiral_comm this is a good one to knock out!! Very helpful to us to do this in the beginning of the cycle!

@StefanThoma
Copy link
Collaborator

I'll take this one :)

@bms63
Copy link
Collaborator Author

bms63 commented Aug 21, 2024

Are you still able to complete this?

@StefanThoma
Copy link
Collaborator

Yeah planning to do it by the end of the month.
Does that work for you?

@bms63
Copy link
Collaborator Author

bms63 commented Aug 21, 2024

Yeah planning to do it by the end of the month. Does that work for you?

Perfect!

@StefanThoma
Copy link
Collaborator

StefanThoma commented Aug 27, 2024

@bms63

There is one function that has been superseded but does not call the deprecate_warn or deprecate_error directly, only via deprecated arguments, get_summary_records:

#' Create Summary Records
#'
#' @description
#'
#' r lifecycle::badge("superseded")

Should I remove this function?

@bms63
Copy link
Collaborator Author

bms63 commented Aug 27, 2024

@bms63

There is one function that has been superseded but does not call the deprecate_warn or deprecate_error directly, only via deprecated arguments, get_summary_records:

#' Create Summary Records #' #' @description #' #' r lifecycle::badge("superseded")

Should I remove this function?

We are leaving that function in for a long time even though it has been replaced. It can just keep the superseded badge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants