[3.14] gh-151949: Fix Sphinx reference warnings in `Doc/library/lzma.rst` (GH-153878) by miss-islington · Pull Request #154125 · python/cpython · GitHub
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

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

@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
Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants