Skip to content

gh-105286: Improve typing.py docstrings #105287

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 12 commits into from
Jun 5, 2023
Merged

gh-105286: Improve typing.py docstrings #105287

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
e808f2b
Improve `typing.py` docstrings
AlexWaygood Jun 4, 2023
7f20599
Apply suggestions from code review
AlexWaygood Jun 5, 2023
d59d72b
Update Lib/typing.py
AlexWaygood Jun 5, 2023
f96723e
Update Lib/typing.py
AlexWaygood Jun 5, 2023
9f132e9
Colons
AlexWaygood Jun 5, 2023
e7983b2
Use two colons everywhere
AlexWaygood Jun 5, 2023
ff90369
Newlines following class docstrings as per PEP 257
AlexWaygood Jun 5, 2023
d54c06b
Nit
AlexWaygood Jun 5, 2023
ab3e627
Fix first line of NoReturn docstring
AlexWaygood Jun 5, 2023
748c55f
Better first sentences
AlexWaygood Jun 5, 2023
f9e27e2
Make module docstring more user-facing
AlexWaygood Jun 5, 2023
58fbb0f
Capitalise Point2D
AlexWaygood Jun 5, 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
Next Next commit
Apply suggestions from code review 
Co-authored-by: Shantanu <[email protected]>
  • Loading branch information
@AlexWaygood @hauntsaninja
AlexWaygood and hauntsaninja authored Jun 5, 2023
commit 7f2059924b417fa62a13f1fce4ff48bbf05e2a04
4 changes: 2 additions & 2 deletions Lib/typing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* The public counterpart of the generics API consists of two classes: Generic and Protocol.
* Public helper functions: get_type_hints, overload, cast, final, and others.
Copy link
Member Author

@AlexWaygood AlexWaygood Jun 4, 2023

Choose a reason for hiding this comment

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

Many other public helper functions have been added that aren't listed here, so I just made it an abbreviated list and put "and others" at the end

* Deprecated aliases for collections.abc ABCs.
Copy link
Member

@sobolevn sobolevn Jun 5, 2023

Choose a reason for hiding this comment

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

All points except this one have examples. Is it intentional?

Copy link
Member Author

@AlexWaygood AlexWaygood Jun 5, 2023

Choose a reason for hiding this comment

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

Yeah, they're deprecated ;p

* Several additional protocols that do not exist elsewhere in the standard library:
* Several additional protocols:
SupportsFloat, SupportsIndex, SupportsAbs, and others.
* Special types: NewType, NamedTuple, TypedDict.
"""
Expand Down Expand Up @@ -655,7 +655,7 @@ def Union(self, parameters):
"""Union type; Union[X, Y] means either X or Y.

On Python 3.10 and higher, the | operator
can also be used to denote unions in many situations;
can also be used to denote unions;
X | Y means the same thing to the type checker as Union[X, Y].

To define a union, use e.g. Union[int, str]. Details:
Expand Down