Skip to content

typing: Improve documentation of generic classes and aliases #105369

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
AlexWaygood merged 6 commits into from
Jun 7, 2023
Merged

typing: Improve documentation of generic classes and aliases #105369

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b66ca2e
typing: Improve documentation of generic classes
AlexWaygood Jun 6, 2023
86ca042
Fix typo
AlexWaygood Jun 6, 2023
25011b3
Partially address review
AlexWaygood Jun 7, 2023
d10f03c
Merge branch 'main' into deprecated-aliases
AlexWaygood Jun 7, 2023
f56a9dd
Sync docstring with change to mention Concatenate
AlexWaygood Jun 7, 2023
1122321
Finish addressing review
AlexWaygood Jun 7, 2023
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
Finish addressing review
  • Loading branch information
@AlexWaygood
AlexWaygood committed Jun 7, 2023
commit 1122321451d9e631808366dbf662cb07730c65aa
3 changes: 2 additions & 1 deletion Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -947,7 +947,8 @@ These can be used as types in annotations using ``[]``, each having a unique syn

Deprecated alias to :class:`collections.abc.Callable`.

``Callable[[int], str]`` signifies a function of (int) -> str.
``Callable[[int], str]`` signifies a function that takes a single parameter
of type :class:`int` and returns a :class:`str`.

The subscription syntax must always be used with exactly two
values: the argument list and the return type. The argument list
Expand Down
4 changes: 3 additions & 1 deletion Lib/typing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2554,7 +2554,9 @@ class Other(Leaf): # Error reported by type checker
Callable.__doc__ = \
"""Deprecated alias to collections.abc.Callable.

Callable[[int], str] signifies a function of (int) -> str.
Callable[[int], str] signifies a function that takes a single
parameter of type int and returns a str.

The subscription syntax must always be used with exactly two
values: the argument list and the return type.
The argument list must be a list of types, a ParamSpec,
Expand Down