Skip to content

gh-149995: Update typing.py docstrings and documentation #149996

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

Merged
JelleZijlstra merged 7 commits into from
May 22, 2026
Merged

gh-149995: Update typing.py docstrings and documentation #149996

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ee09374
gh-149995: Update typing.py docstrings
JelleZijlstra May 18, 2026
0bd5345
blur
JelleZijlstra May 18, 2026
90edd32
docs changes too
JelleZijlstra May 18, 2026
086c6a6
Alex feedback
JelleZijlstra May 18, 2026
6d5b09c
more tweaks
JelleZijlstra May 18, 2026
d712cb3
Update Lib/typing.py
JelleZijlstra May 18, 2026
270a6bf
Update Lib/typing.py
JelleZijlstra May 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Alex feedback
  • Loading branch information
@JelleZijlstra
JelleZijlstra committed May 18, 2026
commit 086c6a68c71ff6a06e20cf39284b1be2b1c684e6
7 changes: 3 additions & 4 deletions Lib/typing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2687,7 +2687,7 @@ def _overload_dummy(*args, **kwds):
def overload(func):
"""Decorator for overloaded functions/methods.

In a stub file, place two or more stub definitions for the same
In a non-stub file, place two or more stub definitions for the same
function in a row, each decorated with @overload, followed
with an implementation. The implementation should *not*
Comment thread
JelleZijlstra marked this conversation as resolved.
Outdated
be decorated with @overload::
Expand All @@ -2701,8 +2701,8 @@ def utf8(value: str) -> bytes: ...
def utf8(value):
... # implementation goes here

In a stub file or in a Protocol definition, the implementation
should be omitted::
In a stub file or in an abstract method (for example, in a Protocol definition),
the implementation may be omitted::

@overload
def utf8(value: None) -> None: ...
Expand All @@ -2711,7 +2711,6 @@ def utf8(value: bytes) -> bytes: ...
@overload
def utf8(value: str) -> bytes: ...


The overloads for a function can be retrieved at runtime using the
get_overloads() function.
"""
Expand Down
Loading