gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst#153878
Open
fedonman wants to merge 2 commits into
Open
gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst#153878fedonman wants to merge 2 commits into
Doc/library/lzma.rst#153878fedonman wants to merge 2 commits into
Conversation
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.
Documentation build overview
6 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.
The
lzmamodule constants (FORMAT_*,CHECK_*,PRESET_*, theFILTER_*names,MODE_*andMF_*) were referenced with the:const:role all overDoc/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 waysignal,socketandsslalready do it, so the existing:const:references resolve to real linked entries. The inline descriptions of the format and check constants inLZMACompressorbecome short linked references, and their full descriptions now live in the new Constants section. The BCJ filter references that are deliberately suppressed (likeFILTER_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 fromlzma.rstare gone and no new ones appear.Sub-issue of #151940.
Doc/library/lzma.rst#151949