[3.15] gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst (GH-153878)#154127
Open
miss-islington wants to merge 1 commit into
Open
[3.15] gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst (GH-153878)#154127miss-islington wants to merge 1 commit into
Doc/library/lzma.rst (GH-153878)#154127miss-islington wants to merge 1 commit into
Conversation
…st` (pythonGH-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 <hi@fedonman.com>
miss-islington
requested review from
AA-Turner,
StanFromIreland and
hugovk
as code owners
July 19, 2026 13:13
zware
enabled auto-merge (squash)
July 19, 2026 13:14
Documentation build overview
304 files changed ·
|
zware
disabled auto-merge
July 19, 2026 13:55
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
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 hi@fedonman.com
Doc/library/lzma.rst#151949