-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Deprecate parse_psm3
and parse_cams
#2458
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
I really think this is a good move, and will reduce maintenance burden in the future.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Absolute LGTM. Two minor nitpicks down below, feel free to ignore one of them (at most!).
Just as a side note, I prefer setting the versions at which they will be removed from the start, but it's not a strong opinion.
""" | ||
Parse an NSRDB PSM3 weather file (formatted as SAM CSV). The NSRDB | ||
Read an NSRDB PSM3 weather file (formatted as SAM CSV). The NSRDB | ||
is described in [1]_ and the SAM CSV format is described in [2]_. | ||
|
||
.. versionchanged:: 0.9.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.. versionchanged:: 0.9.0 |
May be time to clean-up this admonition
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1, but I suggest we do it as part of a wider survey of old versionchanged
s that could be removed
Co-authored-by: Echedey Luis <[email protected]>
I know. The argument in favor of leaving it unspecified is that it gives us flexibility to make the |
Explanations are always welcome. Thanks @kandersolar . |
parse_
iotools functions #2444[ ] Updates entries indocs/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.To keep reviews manageable, I thought it better to not deprecate all the
parse_
functions in one PR. This one does just PSM3 and CAMS, which are both straightforward.