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
Colons 
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
  • Loading branch information
@AlexWaygood @sobolevn
AlexWaygood and sobolevn authored Jun 5, 2023
commit 9f132e9fdb381d0589086a9800000a9cecb2e2df
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 @@ -2225,7 +2225,7 @@ def get_origin(tp):
"""Get the unsubscripted version of a type.

This supports generic types, Callable, Tuple, Union, Literal, Final, ClassVar
Annotated, and others. Return None for unsupported types. Examples:
Annotated, and others. Return None for unsupported types. Examples::

assert get_origin(Literal[42]) is Literal
assert get_origin(int) is None
Expand Down Expand Up @@ -2384,7 +2384,7 @@ def overload(func):
"""Decorator for overloaded functions/methods.

In a stub file, place two or more stub definitions for the same
function in a row, each decorated with @overload. For example:
function in a row, each decorated with @overload. For example::

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

In a non-stub file (i.e. a regular .py file), do the same but
follow it with an implementation. The implementation should *not*
be decorated with @overload. For example:
be decorated with @overload. For example::

@overload
def utf8(value: None) -> None: ...
Expand Down