◐ Shell
reader mode source ↗
Skip to content

gh-101100: Fix Sphinx warning in library/gettext.rst#112668

Merged
hugovk merged 3 commits into
python:mainfrom
hugovk:docs-fix-sphinx-warnings-gettext
Dec 3, 2023
Merged

gh-101100: Fix Sphinx warning in library/gettext.rst#112668
hugovk merged 3 commits into
python:mainfrom
hugovk:docs-fix-sphinx-warnings-gettext

Conversation

@hugovk

@hugovk hugovk commented Dec 3, 2023 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

Most of these underscore-prefixed are described as "protected", I don't think they need documenting individually, so added !.

Also fix RedHat -> Red Hat typo.

❯ SPHINXERRORHANDLING=-n PATH=./venv/bin:$PATH sphinx-build -b html -d build/doctrees -j auto -n . build/html library/gettext.rst  2>&1 | grep WARNING | tee >(wc -l)
Doc/library/gettext.rst:260: WARNING: py:attr reference target not found: _info
Doc/library/gettext.rst:299: WARNING: py:meth reference target not found: _parse
Doc/library/gettext.rst:304: WARNING: py:attr reference target not found: _charset
Doc/library/gettext.rst:317: WARNING: py:attr reference target not found: _info
       4

📚 Documentation preview 📚: https://cpython-previews--112668.org.readthedocs.build/

@bedevere-app bedevere-app Bot mentioned this pull request Dec 3, 2023
Open
@hugovk hugovk added docs Documentation in the Doc dir skip news needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Dec 3, 2023
@hugovk @AlexWaygood
Don't unnecessarily mention internals …
1187d08 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
AlexWaygood
AlexWaygood approved these changes Dec 3, 2023
View reviewed changes

@AlexWaygood AlexWaygood left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

Possibly we could also reduce other references to "protected" private attributes, but the others seem less clear-cut, and I'm not an expert in gettext (maybe it's important that users know about them!), so I'm okay leaving them as they are 👍

AlexWaygood
AlexWaygood reviewed Dec 3, 2023
View reviewed changes

@AlexWaygood AlexWaygood left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

Oh, pet peeve: no need to link to the module we're already in :)

@hugovk @AlexWaygood
No need to link to the module we're already in …
168111e 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@hugovk hugovk enabled auto-merge (squash) December 3, 2023 20:16
@hugovk hugovk merged commit 489aeac into python:main Dec 3, 2023
@hugovk hugovk deleted the docs-fix-sphinx-warnings-gettext branch December 3, 2023 20:23
@miss-islington-app

miss-islington-app Bot commented Dec 3, 2023

Copy link
Copy Markdown

Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@miss-islington-app

miss-islington-app Bot commented Dec 3, 2023

Copy link
Copy Markdown

Sorry, @hugovk, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 489aeac3a2d3b347ff033334688e2f44eec7944a 3.12

@bedevere-app

bedevere-app Bot commented Dec 3, 2023

Copy link
Copy Markdown

GH-112673 is a backport of this pull request to the 3.11 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 3, 2023
@hugovk @AlexWaygood @miss-islington
pythongh-101100: Fix Sphinx warning in library/gettext.rst (pythonG… …
287a842 
…H-112668)

(cherry picked from commit 489aeac)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-app bedevere-app Bot removed the needs backport to 3.11 only security fixes label Dec 3, 2023
@bedevere-app

bedevere-app Bot commented Dec 3, 2023

Copy link
Copy Markdown

GH-112674 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.12 only security fixes label Dec 3, 2023
hugovk added a commit to hugovk/cpython that referenced this pull request Dec 3, 2023
@hugovk @AlexWaygood
[3.12] pythongh-101100: Fix Sphinx warning in library/gettext.rst (p… …
6ccd1a9 
…ythonGH-112668)

(cherry picked from commit 489aeac)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
AlexWaygood added a commit that referenced this pull request Dec 3, 2023
@miss-islington @hugovk @AlexWaygood
[3.11] gh-101100: Fix Sphinx warning in library/gettext.rst (GH-112668 …
73411ea 
) (#112673)

gh-101100: Fix Sphinx warning in `library/gettext.rst` (GH-112668)
(cherry picked from commit 489aeac)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
hugovk added a commit that referenced this pull request Dec 3, 2023
@hugovk @AlexWaygood
[3.12] gh-101100: Fix Sphinx warning in library/gettext.rst (GH-112668 …
da73a5c 
) (#112674)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@hugovk @AlexWaygood @aisk
pythongh-101100: Fix Sphinx warning in library/gettext.rst (python#… …
c53c5ae 
…112668)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@hugovk @AlexWaygood @Glyphack
pythongh-101100: Fix Sphinx warning in library/gettext.rst (python#… …
e4d7a2b 
…112668)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AlexWaygood AlexWaygood AlexWaygood approved these changes

Assignees

@hugovk hugovk

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@hugovk @AlexWaygood