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.

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
merged 5 commits into from
Jul 9, 2025
Merged

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

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c08c01e
gh-136145: Define 'standard library' and 'stdlib' in the glossary
zware Jun 30, 2025
a4a09f1
Correct glossary ordering
zware Jun 30, 2025
4b5f182
Reword stdlib entry
hugovk Jun 30, 2025
c51e13c
Rewording
zware Jul 3, 2025
ff28f45
s/system packages/system libraries/
zware Jul 9, 2025
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: 10 additions & 0 deletions Doc/glossary.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1280,6 +1280,13 @@ 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, or an individual member of
that collection. The exact membership of the collection may vary based
Copy link
Member

@terryjreedy terryjreedy Jun 30, 2025 •
edited by picnixz
Loading

Choose a reason for hiding this comment

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

As a noun, 'standard library' refers to the entire collecton. As an adjective, it can be applied to any member. Giving both definitions in one sentence is confusing.

Suggested change
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, or an individual member of
that collection. The exact membership of the collection may vary based
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. As an adjective, "a member of"
that collection. The exact membership of the collection may vary based

Copy link
Member Author

Choose a reason for hiding this comment

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

I think I'd prefer to just leave out that sentence.

My intention was to cover the (admittedly rare) use of "standard library" to refer to an individual library, such as "... the json standard library." But, I suppose that's still the adjective case, where "module" is implicit after "library" and really it's just superfluous.

on platform, available system packages, or other criteria.

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 +1297,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`.

Copy link

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