Explained what a deprecation cycle is #5289
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andersy005
reviewed
May 11, 2021
Co-authored-by: Anderson Banihirwe <axbanihirwe@ualr.edu>
|
@TomNicholas, the tag needs to be exactly |
andersy005
approved these changes
May 11, 2021
mathause
approved these changes
May 11, 2021
Co-authored-by: Mathias Hauser <mathause@users.noreply.github.com>
Co-authored-by: Mathias Hauser <mathause@users.noreply.github.com>
keewis
reviewed
May 12, 2021
doc/contributing.rst
Outdated
Comment on lines
395
to
398
| warn( | ||
| "`old_arg` has been deprecated, and in the future will raise an error." | ||
| "Please use `new_arg` from now on." | ||
| ) |
There was a problem hiding this comment.
shouldn't we also specify the warning? I'd say DeprecationWarning, but the docs are not really clear on this: it says the target audience for FutureWarning is the users of an application, which I assume is not what we want.
There was a problem hiding this comment.
I've synthesized the difference as FutureWarning is for behavior changes, and DeprecationWarning is for removal. I'm still not confident that's exactly right!
But DeprecationWarning is right here I think
There was a problem hiding this comment.
I'm still not confident that's exactly right!
according to the docs (immediately below the table), that was the case before python=3.7. I don't think that explanation of the difference is particularly easy to understand, though.
Since xarray is not a application, should we always use DeprecationWarning?
keewis
reviewed
May 12, 2021
|
Thanks @TomNicholas |
dcherian
added a commit
to TomNicholas/xarray
that referenced
this pull request
May 13, 2021
* upstream/master: combine keep_attrs and combine_attrs in apply_ufunc (pydata#5041) Explained what a deprecation cycle is (pydata#5289) Code cleanup (pydata#5234) FacetGrid docstrings (pydata#5293) Add whats new for dataset interpolation with non-numerics (pydata#5297) Allow dataset interpolation with different datatypes (pydata#5008) Flexible indexes: add Index base class and xindexes properties (pydata#5102) pre-commit: autoupdate hook versions (pydata#5280) convert the examples for apply_ufunc to doctest (pydata#5279) fix the new whatsnew section Ensure `HighLevelGraph` layers are `Layer` instances (pydata#5271)
dcherian
added a commit
to matzegoebel/xarray
that referenced
this pull request
May 13, 2021
* upstream/master: (23 commits) combine keep_attrs and combine_attrs in apply_ufunc (pydata#5041) Explained what a deprecation cycle is (pydata#5289) Code cleanup (pydata#5234) FacetGrid docstrings (pydata#5293) Add whats new for dataset interpolation with non-numerics (pydata#5297) Allow dataset interpolation with different datatypes (pydata#5008) Flexible indexes: add Index base class and xindexes properties (pydata#5102) pre-commit: autoupdate hook versions (pydata#5280) convert the examples for apply_ufunc to doctest (pydata#5279) fix the new whatsnew section Ensure `HighLevelGraph` layers are `Layer` instances (pydata#5271) New whatsnew section Release-workflow: Bug fix (pydata#5273) more maintenance on whats-new.rst (pydata#5272) v0.18.0 release highlights (pydata#5266) Fix exception when display_expand_data=False for file-backed array. (pydata#5235) Warn ignored keep attrs (pydata#5265) Disable workflows on forks (pydata#5267) fix the built wheel test (pydata#5270) pypi upload workflow maintenance (pydata#5269) ...
dcherian
added a commit
to gcaria/xarray
that referenced
this pull request
May 13, 2021
…e_units * upstream/master: combine keep_attrs and combine_attrs in apply_ufunc (pydata#5041) Explained what a deprecation cycle is (pydata#5289) Code cleanup (pydata#5234) FacetGrid docstrings (pydata#5293) Add whats new for dataset interpolation with non-numerics (pydata#5297) Allow dataset interpolation with different datatypes (pydata#5008) Flexible indexes: add Index base class and xindexes properties (pydata#5102)
dcherian
added a commit
to ahuang11/xarray
that referenced
this pull request
May 13, 2021
* upstream/master: Update release guide (pydata#5274) combine keep_attrs and combine_attrs in apply_ufunc (pydata#5041) Explained what a deprecation cycle is (pydata#5289) Code cleanup (pydata#5234) FacetGrid docstrings (pydata#5293) Add whats new for dataset interpolation with non-numerics (pydata#5297) Allow dataset interpolation with different datatypes (pydata#5008)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Inspired by a question asked in #4696, but does not close that issue
pre-commit run --all-fileswhats-new.rst