Skip to content

docs: remove unnecessary PEP references in libraries guide #2288

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 1 commit into from
May 16, 2026
+5 −5
Merged

docs: remove unnecessary PEP references in libraries guide #2288

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions docs/guides/libraries.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,8 +353,8 @@ Overloads

If a function or method can return multiple different types and those
types can be determined based on the presence or types of certain
parameters, use the ``@overload`` mechanism defined in `PEP
484 <https://www.python.org/dev/peps/pep-0484/#id45>`__. When overloads
parameters, use the ``@overload`` mechanism described in the
:py:data:`typing.overload` documentation. When overloads
are used within a “.py” file, they must appear prior to the function
implementation, which should not have an ``@overload`` decorator.

Expand Down Expand Up @@ -471,8 +471,8 @@ Generic Classes and Functions
-----------------------------

Classes and functions that can operate in a generic manner on various
types should declare themselves as generic using the mechanisms
described in :pep:`484`.
types should declare themselves as generic using standard typing
mechanisms such as ``TypeVar``.
This includes the use of ``TypeVar`` symbols. Typically, a ``TypeVar``
should be private to the file that declares it, and should therefore
begin with an underscore.
Expand All @@ -499,7 +499,7 @@ annotation.
# Recursive type alias
TreeNode = LeafNode | list["TreeNode"]

# Explicit type alias using PEP 613 syntax
# Explicit type alias using TypeAlias
StrOrInt: TypeAlias = str | int

Abstract Classes and Methods
Expand Down