GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — gh-139707: Add docs for optional modules by encukou · Pull Request #140171 · python/cpython

Conversation

encukou commented Oct 15, 2025 •

edited by github-actions Bot

Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link

Copy Markdown

Member

Issue: docs should mention that compression.zstd and other modules are optional #139707

📚 Documentation preview 📚: https://cpython-previews--140171.org.readthedocs.build/

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

encukou added 5 commits

October 15, 2025 16:33


          Use a table for optional module dependencies

d89a92d


          Add a little note to "Building Python"

3cff681


          Move requirements for regenerating configure

f8f2161


          Requirements for Optional Modules

c8f3521


          Add notes to affected modules

b9de785

bedevere-app Bot added docs

Documentation in the Doc dir

skip news labels

Oct 15, 2025

github-project-automation Bot added this to Docs PRs

Oct 15, 2025

github-project-automation Bot moved this to Todo in Docs PRs

Oct 15, 2025

bedevere-app Bot mentioned this pull request

Oct 15, 2025

docs should mention that compression.zstd and other modules are optional #139707

Closed


          Fix ReST syntax

9f2c9e5

... And add Stan as contributor:

Co-authored-by: Stan Ulbrych <[email protected]>

StanFromIreland reviewed

Oct 15, 2025

View reviewed changes

Comment thread

Doc/using/unix.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/glossary.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

StanFromIreland commented Oct 15, 2025

Copy link

Copy Markdown

Member

pre-commit install is handy :-)

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

hugovk reviewed

Oct 15, 2025

View reviewed changes

Comment thread

Doc/using/configure.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/using/configure.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

vstinner reviewed

Oct 16, 2025

View reviewed changes

Comment thread

Doc/library/zlib.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/using/configure.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

encukou and others added 4 commits

October 22, 2025 16:13


          Apply suggestions from code review

145f0fc

Co-authored-by: Stan Ulbrych <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>


          Adjust for libmpdec change

cd7b042


          Add and cross-link notes in optional module docs

2f91ce5


          Merge in the main branch

12bf464

encukou marked this pull request as ready for review

October 22, 2025 14:47

encukou requested review from AA-Turner, berkerpeksag, corona10, erlend-aasland, ethanfurman, gpshead, pfmoore, picnixz, pradyunsg and terryjreedy as code owners

October 22, 2025 14:47

bedevere-app Bot added the awaiting core review label

Oct 22, 2025

StanFromIreland reviewed

Oct 22, 2025

There was an error while loading. Please reload this page.

encukou and others added 2 commits

October 23, 2025 09:03


          Apply suggestions from code review

644a7d5

Co-authored-by: Stan Ulbrych <[email protected]>


          Apply suggestions from code review

88dc122

Co-authored-by: Stan Ulbrych <[email protected]>

terryjreedy reviewed

Oct 25, 2025

View reviewed changes

Comment thread

Doc/library/idle.rst


		* configuration, browsers, and other dialogs

		.. include:: ../includes/optional-module.rst

terryjreedy Oct 25, 2025

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

This is the appropriate place for this, rather than buried in the idlelib entry at the end. Possible suggestion to make the include fit even better.

Suggested change

	.. include:: ../includes/optional-module.rst
	The IDLE application is implemented in the idlelib package.

	.. include:: ../includes/optional-module.rst

with idlelib linked to the entry at the end of the file. OR I could do in a separate PR.

I am also considering adding ":mod: idlelib and " to the beginning of the title in a separate issue. Would have to look at the result, including indexing.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

encukou reacted with thumbs up emoji

All reactions

👍 1 reaction

encukou Nov 5, 2025

Copy link

Copy Markdown

Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Thanks! I added this suggestion.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

Shakacro approved these changes

Nov 1, 2025

View reviewed changes

encukou and others added 5 commits

November 5, 2025 12:36


          Apply suggestions from code review

7a7050b

Co-authored-by: Emma Smith <[email protected]>
Co-authored-by: Stan Ulbrych <[email protected]>


          Merge in the main branch

46d8713


          Platform availability

d62c851


          Abjust wording to cover platform-specific optional modules


          Note idlelib at the start of IDLE docs

828c391

vstinner approved these changes

Nov 5, 2025

View reviewed changes

vstinner left a comment

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

LGTM.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

Comment thread

Doc/using/configure.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/using/configure.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

bedevere-app Bot added awaiting merge and removed awaiting core review labels

Nov 5, 2025


          Apply suggestions from code review

45f4ec3

Co-authored-by: Victor Stinner <[email protected]>

StanFromIreland approved these changes

Nov 5, 2025

View reviewed changes

StanFromIreland left a comment

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Two little nits, otherwise LGTM.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

Comment thread

Doc/using/unix.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread

Doc/using/configure.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.


          Apply suggestions from code review

66ac795

Co-authored-by: Stan Ulbrych <[email protected]>

encukou merged commit d2ce6d7 into python:main

Nov 6, 2025

28 checks passed

Uh oh!

There was an error while loading. Please reload this page.

bedevere-app Bot removed the awaiting merge label

Nov 6, 2025

github-project-automation Bot moved this from Todo to Done in Docs PRs

Nov 6, 2025

encukou deleted the optional-module-docs branch

November 6, 2025 10:49

encukou added the needs backport to 3.14 bugs and security fixes label

Nov 6, 2025

miss-islington-app Bot commented Nov 6, 2025

Copy link

Copy Markdown

Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

miss-islington-app Bot commented Nov 6, 2025

Copy link

Copy Markdown

Sorry, @encukou, I could not cleanly backport this to 3.14 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker d2ce6d708a9eaac4e546744ca4da359ee6901ebc 3.14

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

miss-islington-app Bot assigned encukou

Nov 6, 2025

bedevere-app Bot commented Nov 7, 2025

Copy link

Copy Markdown

GH-141204 is a backport of this pull request to the 3.14 branch.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label

Nov 7, 2025

StanFromIreland added a commit to StanFromIreland/cpython that referenced this pull request

Nov 7, 2025


          [3.14] pythongh-139707: Add docs for optional modules (pythonGH-140171)

b73cb36

(cherry picked from commit d2ce6d7)

Co-authored-by: Petr Viktorin <[email protected]>
Co-authored-by: Stan Ulbrych <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Emma Smith <[email protected]>
Co-authored-by: Author: Terry Jan Reedy <[email protected]>
Co-authored-by: Victor Stinner <[email protected]>

encukou added a commit that referenced this pull request

Nov 10, 2025


          [3.14] gh-139707: Add docs for optional modules (GH-140171) (GH-141204)

c12a0be

(cherry picked from commit d2ce6d7)

Co-authored-by: Petr Viktorin <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Emma Smith <[email protected]>
Co-authored-by: Author: Terry Jan Reedy <[email protected]>
Co-authored-by: Victor Stinner <[email protected]>

StanFromIreland added a commit to StanFromIreland/cpython that referenced this pull request

Dec 6, 2025


          pythongh-139707: Add docs for optional modules (pythonGH-140171)

1d8bbf1

Co-authored-by: Stan Ulbrych <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Emma Smith <[email protected]>
Co-authored-by: Author: Terry Jan Reedy <[email protected]>
Co-authored-by: Victor Stinner <[email protected]>

Reviewers

hugovk

hugovk left review comments

terryjreedy

terryjreedy left review comments

ZeroIntensity

ZeroIntensity left review comments

vstinner

vstinner approved these changes

StanFromIreland

StanFromIreland approved these changes

ethanfurman

Awaiting requested review from ethanfurman

ethanfurman is a code owner

berkerpeksag

Awaiting requested review from berkerpeksag

erlend-aasland

Awaiting requested review from erlend-aasland

erlend-aasland is a code owner

pfmoore

Awaiting requested review from pfmoore

pfmoore is a code owner

pradyunsg

Awaiting requested review from pradyunsg

pradyunsg is a code owner

gpshead

Awaiting requested review from gpshead

gpshead is a code owner

picnixz

Awaiting requested review from picnixz

picnixz is a code owner

corona10

Awaiting requested review from corona10

corona10 is a code owner

AA-Turner

Awaiting requested review from AA-Turner

AA-Turner is a code owner

emmatyping

Awaiting requested review from emmatyping

emmatyping is a code owner

+1 more reviewer

Shakacro

Shakacro approved these changes

Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

encukou

Labels

docs

Documentation in the Doc dir

skip news

Projects

Docs PRs

Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

8 participants

Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.

GeezerVison

Conversation

encukou commented Oct 15, 2025 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

StanFromIreland commented Oct 15, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

terryjreedy Oct 25, 2025

Choose a reason for hiding this comment

Uh oh!

encukou Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

vstinner left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

StanFromIreland left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

miss-islington-app Bot commented Nov 6, 2025

Uh oh!

miss-islington-app Bot commented Nov 6, 2025

Uh oh!

bedevere-app Bot commented Nov 7, 2025

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

encukou commented Oct 15, 2025 •

edited by github-actions Bot

Loading

Uh oh!

There was an error while loading. Please reload this page.