Skip to content

[3.14] gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst (GH-153878)#154125

Merged
tomasr8 merged 2 commits into
python:3.14from
miss-islington:backport-1530b38-3.14
Jul 23, 2026
Merged

[3.14] gh-151949: Fix Sphinx reference warnings in Doc/library/lzma.rst (GH-153878)#154125
tomasr8 merged 2 commits into
python:3.14from
miss-islington:backport-1530b38-3.14

Conversation

@miss-islington

@miss-islington miss-islington commented Jul 19, 2026

Copy link
Copy Markdown
Contributor

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

…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>
@fedonman

Copy link
Copy Markdown
Contributor

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.

@tomasr8
tomasr8 merged commit 72339c9 into python:3.14 Jul 23, 2026
30 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Sprint Jul 23, 2026
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Jul 23, 2026
@miss-islington
miss-islington deleted the backport-1530b38-3.14 branch July 23, 2026 07:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news sprint

Projects

Status: Done
Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants