Update the compatibility policy #12168
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
Fix various formatting issues and introduce NEXT placeholders where applicable.
twm
force-pushed
the
12167-deprecation-next-docs
branch
from
3d37d7d
to
ed3bd5c
Compare
adiroiban
approved these changes
May 6, 2024
|
|
||
| Functions and methods | ||
| ^^^^^^^^^^^^^^^^^^^^^ | ||
| Pass ``Version("Twisted", "NEXT", 0, 0)`` `incremental placeholder <https://github.com/twisted/incremental#updating>`_ to the to indicate the upcoming release. |
There was a problem hiding this comment.
Shouldn't we recommand a single placeholder ?
I would go with Twisted NEXT as it should be valid for both Python or RST code.
There was a problem hiding this comment.
They're not interchangeable: Version(...) is what you pass to the APIs; Twisted NEXT is what you use in docstrings and/or assertions.
There was a problem hiding this comment.
Thanks for the info.
I see why you might want to have an increment Version instance in Python... but I always felt that this is an overengineering ... at least for the deprecation warning message.
Co-authored-by: Adi Roiban <adiroiban@gmail.com>
|
Thanks Adi! |
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.
Fix various formatting issues and introduce NEXT placeholders where applicable.
Scope and purpose
Fixes #12167.
I noticed that the reST syntax for notes was mangled, resulting in the note content being hidden. I restored these notes.
I also removed language about "new-style" classes because old-style classes are mercifully a thing of the past and reworded/rearranged some sections.