Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Deprecation docs should use NEXT placeholders #12167

Closed
twm opened this issue May 6, 2024 · 0 comments · Fixed by #12168
Closed

Deprecation docs should use NEXT placeholders #12167

twm opened this issue May 6, 2024 · 0 comments · Fixed by #12168
Assignees
@twm
Labels
documentation

Comments

@twm
Copy link
Contributor

twm commented May 6, 2024

The compatibility policy contains a number of examples of how to deprecate APIs that hard-code specific Twisted versions. This isn't what a Twisted developer should actually write: new deprecations should be written with incremental placeholders:

Version("Twisted", "NEXT", 0, 0)

Twisted NEXT

The documentation should match practice.
@twm twm self-assigned this May 6, 2024
@twm twm mentioned this issue May 6, 2024
Merged
@twm twm closed this as completed in #12168 May 6, 2024
twm added a commit that referenced this issue May 6, 2024
@twm
Update the compatibility policy (#12168)
625a86c 
Fix various formatting issues and introduce NEXT placeholders where applicable.

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.

Fixes #12167.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@twm twm

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update the compatibility policy twisted/twisted
1 participant
@twm