Add FAQ answer about API stability & backwards compatibility #9855
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
for more information, see https://pre-commit.ci
…into api_stability
max-sixty
reviewed
Dec 5, 2024
doc/getting-started-guide/faq.rst
Outdated
|
|
||
| Xarray tries very hard to maintain backwards compatibility in our :ref:`api` between released versions. | ||
| Whilst we do occasionally make breaking changes in order to improve the library, | ||
| we try to `signpost changes <https://docs.xarray.dev/en/stable/contributing.html#backwards-compatibility>`_ with ``DeprecationWarnings`` for many months in advance. |
There was a problem hiding this comment.
Suggested change
| we try to `signpost changes <https://docs.xarray.dev/en/stable/contributing.html#backwards-compatibility>`_ with ``DeprecationWarnings`` for many months in advance. | |
| we `signpost changes <https://docs.xarray.dev/en/stable/contributing.html#backwards-compatibility>`_ with ``DeprecationWarnings`` for many releases in advance. |
There was a problem hiding this comment.
Or
Suggested change
| we try to `signpost changes <https://docs.xarray.dev/en/stable/contributing.html#backwards-compatibility>`_ with ``DeprecationWarnings`` for many months in advance. | |
| our policy is to `signpost changes <https://docs.xarray.dev/en/stable/contributing.html#backwards-compatibility>`_ with ``DeprecationWarnings`` for many releases in advance. |
Co-authored-by: Maximilian Roos <5635139+max-sixty@users.noreply.github.com>
dcherian
approved these changes
Dec 5, 2024
|
This is really needed as a reference in the documentation. I pushed a fix to get RTD running again. Would be nice to get this in. |
Closed
TomNicholas
commented
Jan 30, 2025
TomNicholas
commented
Jan 30, 2025
There was a problem hiding this comment.
Thanks for fixing this @kmuehlbauer - I just noticed one typo
Co-authored-by: Tom Nicholas <tom@cworthy.org>
|
Thanks @TomNicholas! |
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
whats-new.rst