Skip to content

bpo-36984: Improve version added references in typing module docs#13457

Merged
ilevkivskyi merged 1 commit into
python:masterfrom
asottile:typing_new_in_docs_bpo-36984
Jun 2, 2019
Merged

bpo-36984: Improve version added references in typing module docs#13457
ilevkivskyi merged 1 commit into
python:masterfrom
asottile:typing_new_in_docs_bpo-36984

Conversation

@asottile

@asottile asottile commented May 21, 2019

Copy link
Copy Markdown
Contributor

Comment thread Doc/library/typing.rst
A generic version of :class:`collections.deque`.

.. versionadded:: 3.5.4
.. versionadded:: 3.6.1

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is there 2 "versionadded" here ? was this added both ein 3.5.4 and 3.6.1 ? Meaning it's not in 3.6.0 ?
If that's the case that might look like a typo in the docs from a casual reader, and might need a clarification paragraph.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's correct! it is pretty weird!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, the story with versions is related to the fact that typing module used to be provisional, so features were added at random time, even between minor releases.

Comment thread Doc/library/typing.rst
A generic version of :class:`collections.Counter`.

.. versionadded:: 3.5.4
.. versionadded:: 3.6.1

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same on all of these; that feel super weird;

@Carreau Carreau left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Version added are always super useful.

@csabella
csabella requested review from ilevkivskyi and removed request for ilevkivskyi June 1, 2019 11:46

@ilevkivskyi ilevkivskyi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, LGTM!

Comment thread Doc/library/typing.rst
A generic version of :class:`collections.deque`.

.. versionadded:: 3.5.4
.. versionadded:: 3.6.1

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, the story with versions is related to the fact that typing module used to be provisional, so features were added at random time, even between minor releases.

@miss-islington

Copy link
Copy Markdown
Contributor

Thanks @asottile for the PR, and @ilevkivskyi for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 2, 2019
)

(cherry picked from commit b7daabd)

Co-authored-by: Anthony Sottile <asottile@umich.edu>
@bedevere-bot

Copy link
Copy Markdown

GH-13737 is a backport of this pull request to the 3.7 branch.

miss-islington added a commit that referenced this pull request Jun 2, 2019
(cherry picked from commit b7daabd)

Co-authored-by: Anthony Sottile <asottile@umich.edu>
@asottile
asottile deleted the typing_new_in_docs_bpo-36984 branch June 2, 2019 00:56
DinoV pushed a commit to DinoV/cpython that referenced this pull request Jan 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants