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

[DEV WORKFLOW]: Deprecation removal claims are not enforced in pvlib's lifecycle #2325

Open
echedey-ls opened this issue Dec 5, 2024 · 2 comments

Comments

@echedey-ls
Copy link
Contributor

echedey-ls commented Dec 5, 2024

Is your feature request related to a problem? Please describe.
Frustration kicks in when I find deprecated features that were supposed to be removed in the past. It's like, am I browsing someone's branch not up-to-date? Do I have some virtual environment with a pvlib fossil installed? The answer is, no, it's just some legacy deprecated code still there!

Jokes aside, here are some examples found on the wild of issues reporting forgotten removals:

Describe the solution you'd like
Any procedure that avoids forgetting them. The best one that comes to my mind right now is:

  1. Create issues immediately after a PR introduces a deprecation, label and milestone them appropriately:
    1. Requires creating more version milestones.
    2. I'd love labels for them, at least deprecation. May consider others as well.
  2. Require @fail_on_pvlib_version in warning tests in the PRs introducing the deprecation, so tests fail when pvlib gets to the scheduled removal version.
  3. Add or modify PR template to remind contributors and maintainers.

Describe alternatives you've considered
a. Add a label introduces deprecation to easily browse which PRs may need a follow-up.
b. Keep the original issue of the PR introducing deprecations open, and reassign milestone. (-1)
c. Rely on the quality testers (i.e., users (i.e., do nothing)) (-1)

Additional context
I fear the same outcome for:

Feel free to weight in, specially if you know of other alternatives :D

@kandersolar
Copy link
Member

SciPy has a pinned "deprecation tracker" issue. I've never opened it up to look at it, but perhaps looking at their process would be instructive for us.

@AdamRJensen
Copy link
Member

AdamRJensen commented Dec 10, 2024

Potentially we could create an issue that acts as a deprecation tracker for each upcoming major version? A bit like the release planning issues, but created much earlier

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

No branches or pull requests

3 participants