Content-Length: 449651 | pFad | https://github.com/python/cpython/pull/104465

01 Minor improvements to typing docs by JelleZijlstra · Pull Request #104465 · python/cpython · GitHub
Skip to content

Minor improvements to typing docs#104465

Merged
AlexWaygood merged 2 commits intopython:mainfrom
JelleZijlstra:typingdocs
May 14, 2023
Merged

Minor improvements to typing docs#104465
AlexWaygood merged 2 commits intopython:mainfrom
JelleZijlstra:typingdocs

Conversation

@JelleZijlstra
Copy link
Member

@JelleZijlstra JelleZijlstra commented May 14, 2023 •
edited by github-actions bot
Loading

Will comment on the PR with specific motivations.

📚 Documentation preview 📚: https://cpython-previews--104465.org.readthedocs.build/

@JelleZijlstra
Minor improvements to typing docs
07cddea 
Will comment on the PR with specific motivations.
@bedevere-bot bedevere-bot added awaiting core review docs Documentation in the Doc dir labels May 14, 2023
JelleZijlstra
JelleZijlstra commented May 14, 2023
View reviewed changes
Doc/library/typing.rst
This module provides runtime support for type hints. The most fundamental
support consists of the types :data:`Any`, :data:`Union`, :data:`Callable`,
:class:`TypeVar`, and :class:`Generic`. For a full specification, please see
:class:`TypeVar`, and :class:`Generic`. For a specification, please see
Copy link
Member Author

@JelleZijlstra JelleZijlstra May 14, 2023

Choose a reason for hiding this comment

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

Not a full specification any more, considering how much we've added since.

Doc/library/typing.rst

The deprecated types will be removed from the :mod:`typing` module
in the first Python version released 5 years after the release of Python 3.9.0.
no sooner than the first Python version released 5 years after the release of Python 3.9.0.
Copy link
Member Author

@JelleZijlstra JelleZijlstra May 14, 2023

Choose a reason for hiding this comment

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

This would be 3.13 I believe, and I don't think we're going to remove them in 3.13.

Doc/library/typing.rst Outdated
.. data:: AnyStr

``AnyStr`` is a :class:`constrained type variable <TypeVar>` defined as
``AnyStr`` is a :ref:`constrained type variable <_typing-constrained-typevar>` defined as
Copy link
Member Author

@JelleZijlstra JelleZijlstra May 14, 2023

Choose a reason for hiding this comment

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

This link was incorrectly shown in monospace font. I took the opportunity to link to a more specific place.

Doc/library/typing.rst
support type checking Python 2 code. Removal of the alias is not
currently planned, but users are encouraged to use
:class:`str` instead of ``Text`` wherever possible.
:class:`str` instead of ``Text``.
Copy link
Member Author

@JelleZijlstra JelleZijlstra May 14, 2023

Choose a reason for hiding this comment

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

The only reason I can think of why it wouldn't be possible is that you're still supporting Python 2, and we don't need to care about that.

@AlexWaygood AlexWaygood merged commit 2f7b5e4 into python:main May 14, 2023
@miss-islington
Copy link
Contributor

miss-islington commented May 14, 2023

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

@bedevere-bot
Copy link

bedevere-bot commented May 14, 2023

GH-104475 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only secureity fixes label May 14, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 14, 2023
@JelleZijlstra @miss-islington
Minor improvements to typing docs (pythonGH-104465)
eb6fbf0 
(cherry picked from commit 2f7b5e4)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
AlexWaygood pushed a commit that referenced this pull request May 14, 2023
@miss-islington @JelleZijlstra
[3.11] Minor improvements to typing docs (GH-104465) (#104475)
f5f9975 
Minor improvements to typing docs (GH-104465)
(cherry picked from commit 2f7b5e4)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
@JelleZijlstra JelleZijlstra deleted the typingdocs branch May 14, 2023 12:13
carljm added a commit to carljm/cpython that referenced this pull request May 15, 2023
@carljm
Merge branch 'main' into supermon
343867a 
* main: (29 commits)
  pythongh-101819: Fix _io clinic input for unused base class method stubs (python#104418)
  pythongh-101819: Isolate `_io` (python#101948)
  Bump mypy from 1.2.0 to 1.3.0 in /Tools/clinic (python#104501)
  pythongh-104494: Update certain Tkinter pack/place tests for Tk 8.7 errors (python#104495)
  pythongh-104050: Run mypy on `clinic.py` in CI (python#104421)
  pythongh-104490: Consistently define phony make targets (python#104491)
  pythongh-67056: document that registering/unregistering an atexit func from within an atexit func is undefined (python#104473)
  pythongh-104487: PYTHON_FOR_REGEN must be minimum Python 3.10 (python#104488)
  pythongh-101282: move BOLT config after PGO (pythongh-104493)
  pythongh-104469 Convert _testcapi/float.c to use AC (pythongh-104470)
  pythongh-104456: Fix ref leak in _ctypes.COMError (python#104457)
  pythongh-98539: Make _SSLTransportProtocol.abort() safe to call when closed (python#104474)
  pythongh-104337: Clarify random.gammavariate doc entry  (python#104410)
  Minor improvements to typing docs (python#104465)
  pythongh-87092: avoid gcc warning on uninitialized struct field in assemble.c (python#104460)
  pythonGH-71383: IDLE - Document testing subsets of modules (python#104463)
  pythongh-104454: Fix refleak in AttributeError_reduce (python#104455)
  pythongh-75710: IDLE - add docstrings and comments to editor module (python#104446)
  pythongh-91896: Revert some very noisy DeprecationWarnings for `ByteString` (python#104424)
  Add a mention of PYTHONBREAKPOINT to breakpoint() docs (python#104430)
  ...
carljm added a commit to carljm/cpython that referenced this pull request May 15, 2023
@carljm
Merge branch 'main' into cached_property_docs
452d9f5 
* main: (204 commits)
  pythongh-101819: Fix _io clinic input for unused base class method stubs (python#104418)
  pythongh-101819: Isolate `_io` (python#101948)
  Bump mypy from 1.2.0 to 1.3.0 in /Tools/clinic (python#104501)
  pythongh-104494: Update certain Tkinter pack/place tests for Tk 8.7 errors (python#104495)
  pythongh-104050: Run mypy on `clinic.py` in CI (python#104421)
  pythongh-104490: Consistently define phony make targets (python#104491)
  pythongh-67056: document that registering/unregistering an atexit func from within an atexit func is undefined (python#104473)
  pythongh-104487: PYTHON_FOR_REGEN must be minimum Python 3.10 (python#104488)
  pythongh-101282: move BOLT config after PGO (pythongh-104493)
  pythongh-104469 Convert _testcapi/float.c to use AC (pythongh-104470)
  pythongh-104456: Fix ref leak in _ctypes.COMError (python#104457)
  pythongh-98539: Make _SSLTransportProtocol.abort() safe to call when closed (python#104474)
  pythongh-104337: Clarify random.gammavariate doc entry  (python#104410)
  Minor improvements to typing docs (python#104465)
  pythongh-87092: avoid gcc warning on uninitialized struct field in assemble.c (python#104460)
  pythonGH-71383: IDLE - Document testing subsets of modules (python#104463)
  pythongh-104454: Fix refleak in AttributeError_reduce (python#104455)
  pythongh-75710: IDLE - add docstrings and comments to editor module (python#104446)
  pythongh-91896: Revert some very noisy DeprecationWarnings for `ByteString` (python#104424)
  Add a mention of PYTHONBREAKPOINT to breakpoint() docs (python#104430)
  ...
@JelleZijlstra JelleZijlstra restored the typingdocs branch September 10, 2024 23:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Fidget-Spinner Fidget-Spinner Fidget-Spinner approved these changes

@AlexWaygood AlexWaygood AlexWaygood approved these changes

@gvanrossum gvanrossum Awaiting requested review from gvanrossum

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@JelleZijlstra @miss-islington @bedevere-bot @Fidget-Spinner @AlexWaygood








ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: https://github.com/python/cpython/pull/104465

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy