[DEVOPS] Deprecation warning wrapper for dict-like object renamed keys #2530
+349
−15
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
return_components=True
transposition model outputs #2529 (see for other relevant comments, in pvlib threads)docs/sphinx/source/reference
for API changes.docs/sphinx/source/whatsnew
for all changes. Includes link to the GitHub Issue with:issue:`num`
or this Pull Request with:pull:`num`
. Includes contributor name and/or GitHub username (link with:ghuser:`user`
).remote-data
) and Milestone are assigned to the Pull Request and linked Issue.Threatening my mail inbox again, duh? Just kidding.
But let's give us the opportunity to make the renaming of all and any keys in returned dictionaries and dataframes be not a super, duper, user-angering, developer-exhausting, breaking change.
Key changes that come with this PR:
pvlib._deprecation
functions listing. I've named it devops for now.I understand if there are objections to the new doc page. Suggestions, like whole removal, etc welcome. Just wanted to propose making the docstrings the first place to check, rather than finding past or current uses to see how to use the utilities in that deprecation submodule. I was unsure of the best fit for that, so in the contributing section it went..
Regarding, the new func / wrapper, I doubt there are no doubts. Let me know any objections, concerns, or ways to improve either the implementation or the tests, not covered by the documentation.
As always, a friendly proposal. If you want, I can also add an example of how this would look like for #2529 (quick search didn't give any useful results of other issues that may benefit from this).
Handy links for every1