-
Notifications
You must be signed in to change notification settings - Fork 1k
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
Comments
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. |
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 |
I propose opening and pinning the template down below. Feel free to propose any changes. I've added the 0.11.0 as an example of how it would look like. I also recommend limiting conversation only to collaborators / maintainers, since this issue is expected to have a long lifecycle and a lot of conversation may pile up. Deprecations Tracking IssueThis issue is used to track past, present, and future deprecations and make the required follow-ups. Maintainers may update this issue whenever a feature is deprecated, renamed, or removed. If you have found a deprecated feature that is not here, please report it via a new issue or the mailing list. Upcoming changes
Past changes
|
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:
pvlib.iotools.read_tmy3
deprecatedrecolumn
parameter removal scheduled forv0.11.0
, still there #2324pvsystem.sapm_spectral_loss
not removed #2243 (TBF this one didn't claim any removal version, just stated soon after its announcement inv0.10.0
)pvlib.atmosphere.first_solar_spectral_correction
not scheduled for removal #2130 (same as previous)Describe the solution you'd like
Any procedure that avoids forgetting them. The best one that comes to my mind right now is:
deprecation
. May consider others as well.@fail_on_pvlib_version
in warning tests in the PRs introducing the deprecation, so tests fail whenpvlib
gets to the scheduled removal version.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:
dni_clear
variable name for clearsky DNI #2274Feel free to weight in, specially if you know of other alternatives :D
The text was updated successfully, but these errors were encountered: