[3.13] gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst (GH-153878)#154483
Closed
fedonman wants to merge 1 commit into
Closed
[3.13] gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst (GH-153878)#154483fedonman wants to merge 1 commit into
Doc/library/lzma.rst (GH-153878)#154483fedonman 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>
Documentation build overview
469 files changed ·
|
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
1 participant
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.
This is a manual backport of #153878 to 3.13.
The automated backport (#154126) fails the docs build. That PR removes
Doc/library/lzma.rstfrom the nitpick ignore list, but on 3.13 six of the BCJ filter references in that file are still unresolved and now show up as warnings:FILTER_X86,FILTER_IA64,FILTER_ARM,FILTER_ARMTHUMB,FILTER_POWERPCandFILTER_SPARC.On main those names are written with a leading
!, which tells Sphinx to render them as plain text without looking for a reference target. That prefix was added by the change that introduced the ARM64 and RISCV filters (GH-115989), which was never backported, so the release branches still carry the plain references.This backport adds the same
!prefix to those six lines, so the file builds cleanly under nitpicky mode and renders the same way it does on main. I checked with a nitpicky docs build thatlzma.rstproduces no warnings.Supersedes #154126.
Doc/library/lzma.rst#151949