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
Capitalise Point2D
  • Loading branch information
@AlexWaygood
AlexWaygood committed Jun 5, 2023
commit 58fbb0f5cb68e5044b6ac891a8b910ce7817ae36
6 changes: 3 additions & 3 deletions Lib/typing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2874,19 +2874,19 @@ class Point2D(TypedDict):
By default, all keys must be present in a TypedDict. It is possible
to override this by specifying totality::

class point2D(TypedDict, total=False):
class Point2D(TypedDict, total=False):
x: int
y: int

This means that a point2D TypedDict can have any of the keys omitted. A type
This means that a Point2D TypedDict can have any of the keys omitted. A type
checker is only expected to support a literal False or True as the value of
the total argument. True is the default, and makes all items defined in the
class body be required.

The Required and NotRequired special forms can also be used to mark
individual keys as being required or not required::

class point2D(TypedDict):
class Point2D(TypedDict):
x: int # the "x" key must always be present (Required is the default)
y: NotRequired[int] # the "y" key can be omitted

Expand Down