GV

GeezerVison

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

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-151949: Fix Sphinx reference warnings in `Doc/library/lzma.rst` by fedonman · Pull Request #153878 · python/cpython

Conversation

@fedonman

@fedonman fedonman commented Jul 18, 2026 •
edited
Loading

Uh oh!

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

Copy link
Copy Markdown
Contributor

The lzma module constants (FORMAT_*, CHECK_*, PRESET_*, the FILTER_* names, MODE_* and MF_*) were referenced with the :const: role all over Doc/library/lzma.rst, but none of them were actually defined as reference targets. In nitpicky mode this produced 35 "py:const reference target not found" warnings (the full list is in the issue).

This documents those constants with .. data:: directives, the same way signal, socket and ssl already do it, so the existing :const: references resolve to real linked entries. The inline descriptions of the format and check constants in LZMACompressor become short linked references, and their full descriptions now live in the new Constants section. The BCJ filter references that are deliberately suppressed (like FILTER_X86) are left alone, since they don't emit warnings.

I checked with a nitpicky docs build (sphinx-build -n -D nitpicky=1): all 35 warnings from lzma.rst are gone and no new ones appear.

Sub-issue of #151940.

  • Issue: Fix all Sphinx reference warnings in Doc/library/lzma.rst #151949

Sorry, something went wrong.

Uh oh!

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

All reactions
@fedonman
pythongh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst
473ca2b
The lzma module constants (FORMAT_*, CHECK_*, PRESET_*, FILTER_*, MODE_*
and MF_*) were referenced with the :const: role throughout the module
documentation but were never defined as reference targets, producing
"reference target not found" warnings under nitpicky mode.

Document these public constants with .. data:: directives, following the
convention used by the signal, socket and ssl modules, so the existing
references resolve. The now-redundant inline descriptions of the format
and check constants are condensed into linked references.
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Jul 18, 2026
@github-project-automation github-project-automation Bot added this to Docs PRs Jul 18, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Jul 18, 2026
@bedevere-app bedevere-app Bot mentioned this pull request Jul 18, 2026
Fix all Sphinx reference warnings in Doc/library/lzma.rst #151949
Closed
@bedevere-app bedevere-app Bot added the awaiting review label Jul 18, 2026
@read-the-docs-community

read-the-docs-community Bot commented Jul 18, 2026 •
edited
Loading

Uh oh!

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

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #33653502 | 📁 Comparing 75a1c8a against main (16d0c89)

  🔍 Preview build  

28 files changed · ± 28 modified

± Modified

  • c-api/exceptions.html
  • c-api/frame.html
  • c-api/veryhigh.html
  • howto/abi3t-migration.html
  • howto/logging-cookbook.html
  • library/allos.html
  • library/archiving.html
  • library/asyncio-task.html
  • library/calendar.html
  • library/concurrent.interpreters.html
  • and 18 more...
All reactions

Sorry, something went wrong.

Uh oh!

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

fedonman added 3 commits July 18, 2026 12:29
@fedonman
Merge branch 'main' into fix-pythongh-151949-lzma-sphinx-warnings
a55297b
@fedonman
Merge branch 'main' into fix-pythongh-151949-lzma-sphinx-warnings
0b1eda7
@fedonman
removes Doc/library/lzma.rst from Doc/tools/.nitignore
6d053c8
@fedonman
fedonman requested review from AA-Turner, StanFromIreland and hugovk as code owners July 19, 2026 10:22
fedonman added 2 commits July 19, 2026 13:22
@fedonman
Merge branch 'main' into fix-pythongh-151949-lzma-sphinx-warnings
4d92225
@fedonman
Merge branch 'main' into fix-pythongh-151949-lzma-sphinx-warnings
75a1c8a
@fedonman

fedonman commented Jul 19, 2026

Copy link
Copy Markdown
Contributor Author

@zware part of EuroPython sprint.

zware reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

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

@zware zware added the sprint label Jul 19, 2026
@github-project-automation github-project-automation Bot added this to Sprint Jul 19, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Sprint Jul 19, 2026
zware
zware approved these changes Jul 19, 2026
View reviewed changes

@zware zware 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.

This looks great, thanks!

Sorry, something went wrong.

Uh oh!

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

All reactions
@bedevere-app bedevere-app Bot removed the awaiting review label Jul 19, 2026
@github-project-automation github-project-automation Bot moved this from Todo to In Progress in Sprint Jul 19, 2026
@bedevere-app bedevere-app Bot added the awaiting merge label Jul 19, 2026
@zware
zware merged commit 1530b38 into python:main Jul 19, 2026
36 checks passed

Uh oh!

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

@bedevere-app bedevere-app Bot removed the awaiting merge label Jul 19, 2026
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Sprint Jul 19, 2026
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Jul 19, 2026
@zware zware added needs backport to 3.13 only security fixes needs backport to 3.14 bugs and security fixes labels Jul 19, 2026
@zware zware added the needs backport to 3.15 bugs and security fixes label Jul 19, 2026
@miss-islington-app

miss-islington-app Bot commented Jul 19, 2026

Copy link
Copy Markdown

Thanks @fedonman for the PR, and @zware for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

All reactions

Sorry, something went wrong.

Uh oh!

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

@miss-islington-app

miss-islington-app Bot commented Jul 19, 2026

Copy link
Copy Markdown

Thanks @fedonman for the PR, and @zware for merging it 🌮🎉.. 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

miss-islington-app Bot commented Jul 19, 2026

Copy link
Copy Markdown

Thanks @fedonman for the PR, and @zware for merging it 🌮🎉.. I'm working now to backport this PR to: 3.15.
🐍🍒⛏🤖

All reactions

Sorry, something went wrong.

Uh oh!

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

@bedevere-app

bedevere-app Bot commented Jul 19, 2026

Copy link
Copy Markdown

GH-154125 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 bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Jul 19, 2026
@bedevere-app

bedevere-app Bot commented Jul 19, 2026

Copy link
Copy Markdown

GH-154126 is a backport of this pull request to the 3.13 branch.

All reactions

Sorry, something went wrong.

Uh oh!

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

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 only security fixes label Jul 19, 2026
@bedevere-app

bedevere-app Bot commented Jul 19, 2026

Copy link
Copy Markdown

GH-154127 is a backport of this pull request to the 3.15 branch.

All reactions

Sorry, something went wrong.

Uh oh!

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

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 bugs and security fixes label Jul 19, 2026
This was referenced Jul 22, 2026
[3.13] gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst (GH-153878) #154483
Closed
[3.14] gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst (GH-153878) #154484
Closed
[3.15] gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst (GH-153878) #154485
Closed
@bedevere-app

bedevere-app Bot commented Jul 22, 2026

Copy link
Copy Markdown

GH-154483 is a backport of this pull request to the 3.13 branch.

All reactions

Sorry, something went wrong.

Uh oh!

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

@bedevere-app

bedevere-app Bot commented Jul 22, 2026

Copy link
Copy Markdown

GH-154484 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

bedevere-app Bot commented Jul 22, 2026

Copy link
Copy Markdown

GH-154485 is a backport of this pull request to the 3.15 branch.

All reactions

Sorry, something went wrong.

Uh oh!

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

tomasr8 pushed a commit that referenced this pull request Jul 23, 2026
@miss-islington @fedonman @hugovk
[3.13] gh-151949: Fix Sphinx reference warnings in `Doc/library/lzma.…
df98462
…rst` (GH-153878) (#154126)

* gh-151949: Fix Sphinx reference warnings in `Doc/library/lzma.rst` (GH-153878)

The lzma module constants (FORMAT_*, CHECK_*, PRESET_*, FILTER_*, MODE_*
and MF_*) were referenced with the :const: role throughout the module
documentation but were never defined as reference targets, producing
"reference target not found" warnings under nitpicky mode.

Document these public constants with .. data:: directives, following the
convention used by the signal, socket and ssl modules, so the existing
references resolve. The now-redundant inline descriptions of the format
and check constants are condensed into linked references.
(cherry picked from commit 1530b38)

Co-authored-by: Vyron Vasileiadis <[email protected]>

* Fix nitpicks

---------

Co-authored-by: Vyron Vasileiadis <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
tomasr8 pushed a commit that referenced this pull request Jul 23, 2026
@miss-islington @fedonman @hugovk
[3.14] gh-151949: Fix Sphinx reference warnings in `Doc/library/lzma.…
72339c9
…rst` (GH-153878) (#154125)

* gh-151949: Fix Sphinx reference warnings in `Doc/library/lzma.rst` (GH-153878)

The lzma module constants (FORMAT_*, CHECK_*, PRESET_*, FILTER_*, MODE_*
and MF_*) were referenced with the :const: role throughout the module
documentation but were never defined as reference targets, producing
"reference target not found" warnings under nitpicky mode.

Document these public constants with .. data:: directives, following the
convention used by the signal, socket and ssl modules, so the existing
references resolve. The now-redundant inline descriptions of the format
and check constants are condensed into linked references.
(cherry picked from commit 1530b38)

Co-authored-by: Vyron Vasileiadis <[email protected]>

* Fix nitpicks

---------

Co-authored-by: Vyron Vasileiadis <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
tomasr8 pushed a commit that referenced this pull request Jul 23, 2026
@miss-islington @fedonman @hugovk
[3.15] gh-151949: Fix Sphinx reference warnings in `Doc/library/lzma.…
41d7b3c
…rst` (GH-153878) (#154127)

* gh-151949: Fix Sphinx reference warnings in `Doc/library/lzma.rst` (GH-153878)

The lzma module constants (FORMAT_*, CHECK_*, PRESET_*, FILTER_*, MODE_*
and MF_*) were referenced with the :const: role throughout the module
documentation but were never defined as reference targets, producing
"reference target not found" warnings under nitpicky mode.

Document these public constants with .. data:: directives, following the
convention used by the signal, socket and ssl modules, so the existing
references resolve. The now-redundant inline descriptions of the format
and check constants are condensed into linked references.
(cherry picked from commit 1530b38)

Co-authored-by: Vyron Vasileiadis <[email protected]>

* Fix nitpicks

---------

Co-authored-by: Vyron Vasileiadis <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@zware zware zware approved these changes
@AA-Turner AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner
@hugovk hugovk Awaiting requested review from hugovk hugovk is a code owner
@StanFromIreland StanFromIreland Awaiting requested review from StanFromIreland StanFromIreland is a code owner

Uh oh!

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

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news sprint

Projects

Docs PRs
Status: Done
Sprint
Archived in project

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.

2 participants

@fedonman @zware
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 01402520 — 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.