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

Consider deprecating join_abcd_scenario and summarize_* #468

Open
jdhoffa opened this issue Feb 6, 2024 · 6 comments
Open

Consider deprecating join_abcd_scenario and summarize_* #468

jdhoffa opened this issue Feb 6, 2024 · 6 comments
Labels
ADO Maintenance Day! breaking change ☠️ API change likely to affect existing code upkeep maintenance, infrastructure, and similar

Comments

@jdhoffa
Copy link
Member

jdhoffa commented Feb 6, 2024

These functions are currently exported, but I have no idea if anybody uses them.
To some extent, it feels like we are committing ourselves to a maintenance burden for a decision made long ago.

I am curious if @jacobvjk thinks they are actively used (beyond when they are called in the body of target_* functions)
Curious also how @AlexAxthelm and @cjyetman feel about this (not the details, but in general the process of deprecating a previously exported function)

It feels like probably a bad idea/ bad form, but want your opinions here.

AB#9903

@jdhoffa jdhoffa added breaking change ☠️ API change likely to affect existing code upkeep maintenance, infrastructure, and similar help wanted ❤️ we'd love your help! labels Feb 6, 2024
@cjyetman
Copy link
Member

cjyetman commented Feb 6, 2024

I think that's what "deprecation" is intended for, no?

@AlexAxthelm
Copy link
Contributor

Yeah, Let's support them for another few months, and then internalize them.

@jdhoffa
Copy link
Member Author

jdhoffa commented Feb 6, 2024

Maybe more concretely, my question is:

  • Should I include, in the next release that I push to CRAN, a warning message explaining that we plan to deprecate these functions? (and maybe even a link to making an issue to this repo in case people wish for us to not deprecate them)?

I think this may be an appropriate strategy here

@AlexAxthelm
Copy link
Contributor

I think this is exactly what deprecate_soft() is for, no? Anyone who calls the function directly sees the deprecation warning, anyone who uses it indirectly gets the expected result, some time later, we'll unexport them.

@jdhoffa
Copy link
Member Author

jdhoffa commented Feb 6, 2024

Sounds perfect!

@jdhoffa jdhoffa added the ADO Maintenance Day! label Feb 6, 2024
@jdhoffa jdhoffa self-assigned this Feb 6, 2024
@jdhoffa jdhoffa removed the help wanted ❤️ we'd love your help! label Feb 6, 2024
@jdhoffa
Copy link
Member Author

jdhoffa commented Feb 6, 2024

Help achieved :-) thank you both.

@jdhoffa jdhoffa added ADO Maintenance Day! and removed ADO Maintenance Day! labels Feb 19, 2024
@jdhoffa jdhoffa removed their assignment Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ADO Maintenance Day! breaking change ☠️ API change likely to affect existing code upkeep maintenance, infrastructure, and similar
Projects
None yet
Development

No branches or pull requests

3 participants