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.

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

t.p.deprecate docs should show indeterminate versions #11715

Closed
twm opened this issue Oct 21, 2022 · 0 comments · Fixed by #11720
Closed

t.p.deprecate docs should show indeterminate versions #11715

twm opened this issue Oct 21, 2022 · 0 comments · Fixed by #11720
Assignees

Comments

@twm
Copy link
Contributor

twm commented Oct 21, 2022

The deprecation docs use concrete version numbers, as in this example:

@deprecated(Version("Twisted", 8, 0, 0))
def badAPI(self, first, second):
    '''
    Docstring for badAPI.
    '''
    ...

They should use indeterminate versions instead, since that's what authors should actually write:

@deprecated(Version("Twisted", "NEXT", 0, 0))
def badAPI(self, first, second):
    '''
    Docstring for badAPI.
    '''
    ...
@twm twm self-assigned this Oct 21, 2022
twm added a commit that referenced this issue Oct 24, 2022
twm added a commit that referenced this issue Oct 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant