Skip to content

gh-136145: Define 'standard library' and 'stdlib' in the glossary #136146

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.

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions Doc/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1280,6 +1280,16 @@ Glossary
and ending with double underscores. Special methods are documented in
:ref:`specialnames`.

standard library
The collection of :term:`packages <package>`, :term:`modules <module>`
and :term:`extension modules <extension module>` distributed as a part
of the official Python interpreter package. The exact membership of the
collection may vary based on platform, available system packages, or
other criteria. Documentation can be found at :ref:`library-index`.

See also :data:`sys.stdlib_module_names` for a list of all possible
standard library module names.

statement
A statement is part of a suite (a "block" of code). A statement is either
an :term:`expression` or one of several constructs with a keyword, such
Expand All @@ -1290,6 +1300,9 @@ Glossary
issues such as incorrect types. See also :term:`type hints <type hint>`
and the :mod:`typing` module.

stdlib
An abbreviation of :term:`standard library`.
Copy link
Member

Choose a reason for hiding this comment

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

Should we hint that this isn't the appropriate term to use in CPython docs?

Suggested change
An abbreviation of :term:`standard library`.
An informal abbreviation of :term:`standard library`.

Choose a reason for hiding this comment

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

Should we hint that this isn't the appropriate term to use in CPython docs?

Seems reasonable ... could use "unofficial" as an alternative to "informal". (seems like this small change has gotten a little nitpicky, so I won't go on)

Copy link
Contributor

Choose a reason for hiding this comment

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

Both "informal" and "unofficial" works for me. But I agree that it's better with adjective.

Copy link
Member Author

Choose a reason for hiding this comment

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

Given that we use the term in places like sys.stdlib_module_names, is it "informal" or "unofficial"? There could be a case for the former, but I don't think we can say its "unofficial".


strong reference
In Python's C API, a strong reference is a reference to an object
which is owned by the code holding the reference. The strong
Expand Down
Loading