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

Double versionadded labels in typing.NoReturn doc #115777

Closed
Eclips4 opened this issue Feb 21, 2024 · 3 comments
Closed

Double versionadded labels in typing.NoReturn doc #115777

Eclips4 opened this issue Feb 21, 2024 · 3 comments
Labels
3.11 only security fixes 3.12 bugs and security fixes 3.13 bugs and security fixes docs Documentation in the Doc dir topic-typing

Comments

@Eclips4
Copy link
Member

Eclips4 commented Feb 21, 2024

I think it was added by mistake:

.. versionadded:: 3.5.4
.. versionadded:: 3.6.2

cc @JelleZijlstra @AlexWaygood

Linked PRs

@Eclips4 Eclips4 added docs Documentation in the Doc dir 3.11 only security fixes topic-typing 3.12 bugs and security fixes 3.13 bugs and security fixes labels Feb 21, 2024
@Eclips4
Copy link
Member Author

Eclips4 commented Feb 21, 2024

There's also a couple double versionadded labels in typing.rst: typing.Counter, typing.Deque, typing.ChainMap, typing.AsyncContextManager. For me it is not obvious why is this so.

@JelleZijlstra
Copy link
Member

These are correct. The names were added in 3.5.4 and 3.6.2; i.e., they were not present in 3.5.3 and 3.6.1. Maybe there's a way to make that more clear.

@serhiy-storchaka
Copy link
Member

I think that this is incorrect. Double versionadded directives only occur in typing.rst. In the rest of the documentation, and in most cases in typing.rst, other principle is used -- specify the earliest version such that all releases between the specified version and the documented version should have such feature. For example, if the feature was added in 3.7 and backported to 3.5.4 and 3.6.2, then the docs in the 3.6 and 3.7 branches will contain version 3.6.2, and the docs in the 3.3 branch will contain version 3.5.4.

miss-islington pushed a commit to miss-islington/cpython that referenced this issue Mar 5, 2024
(cherry picked from commit 0064dfa)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Mar 5, 2024
(cherry picked from commit 0064dfa)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
serhiy-storchaka added a commit that referenced this issue Mar 5, 2024
…116361)

(cherry picked from commit 0064dfa)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
serhiy-storchaka added a commit that referenced this issue Mar 5, 2024
…116362)

(cherry picked from commit 0064dfa)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.11 only security fixes 3.12 bugs and security fixes 3.13 bugs and security fixes docs Documentation in the Doc dir topic-typing
Projects
None yet
Development

No branches or pull requests

3 participants