GeezerVison is showing github.com — [3.15] gh-151949: Fix Sphinx reference warnings in `Doc/library/lzma.rst` (GH-153878) by miss-islington · Pull Request #154127 · python/cpython
Conversation
miss-islington
commented
Jul 19, 2026
•
edited by bedevere-app
Bot
Loading
Uh oh!
There was an error while loading. Please reload this page.
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]
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
…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 <[email protected]>
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
@fedonman Looks like there are some extra warnings on the backports, could you take a look?
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
The docs build fails here because this backport removes Doc/library/lzma.rst from Doc/tools/.nitignore, but six BCJ filter references in that file are still unresolved on this branch: FILTER_X86, FILTER_IA64, FILTER_ARM, FILTER_ARMTHUMB, FILTER_POWERPC and FILTER_SPARC.
On main those names carry a leading !, which tells Sphinx to render them as plain text and skip the reference lookup. That prefix came from GH-115989 (the ARM64 and RISCV filters), which was never backported, so this branch still has the plain references.
Adding the same ! prefix to those six lines clears the warnings. I don't have push access to this branch, so a core dev would need to apply it:
* Branch-Call-Jump (BCJ) filters:
- * :const:`FILTER_X86`
- * :const:`FILTER_IA64`
- * :const:`FILTER_ARM`
- * :const:`FILTER_ARMTHUMB`
- * :const:`FILTER_POWERPC`
- * :const:`FILTER_SPARC`
+ * :const:`!FILTER_X86`
+ * :const:`!FILTER_IA64`
+ * :const:`!FILTER_ARM`
+ * :const:`!FILTER_ARMTHUMB`
+ * :const:`!FILTER_POWERPC`
+ * :const:`!FILTER_SPARC`
I checked with a nitpicky docs build that this clears all the lzma.rst warnings.
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
@tomasr8 As far as I know, I can't commit/push to this branch as I am not a core dev. I commented the solution.
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
Thanks for looking into it! If you want, you can create a separate backport PR with the fixes and I'll close this one. Otherwise I'll fix the backports in the following days :)
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
I pushed the fixes, thanks for investigating!
|
fedonman reacted with hooray emoji
tomasr8 reacted with heart emoji
All reactions
-
🎉
1 reaction
-
❤️
1 reaction
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Assignees
No one assigned
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.
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.
|