gh-101100: Fix sphinx warnings in Doc/library/locale.rst
#114425
Merged
Conversation
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
bedevere-app
bot
added
awaiting review
docs
sobolevn
added
needs backport to 3.11
hugovk
reviewed
Jan 22, 2024
Doc/library/locale.rst
Outdated
Comment on lines
629
to
634
| .. function:: gettext(msg, /) | ||
| .. function:: dgettext(domain, msg, /) | ||
| .. function:: dcgettext(domain, msg, category, /) | ||
| .. function:: textdomain(domain, /) | ||
| .. function:: bindtextdomain(domain, dir, /) | ||
| .. function:: bind_textdomain_codeset(domain, codeset, /) |
There was a problem hiding this comment.
I'm not sure if these / args do much to clarify here, shall we revert this bit? I don't think it fixed any warnings?
There was a problem hiding this comment.
Actual functions in locale do not accept keyword args, only pos-only ones. I think that the docs should reflect that. Why do you think that / is not helpful here?
There was a problem hiding this comment.
We have many function signatures in docs that do not reflect the exact technical reality of the code, but instead simplify them, for readability, brevity, and simplicity.
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jan 23, 2024
…honGH-114425) * pythongh-101100: Fix sphinx warnings in `Doc/library/locale.rst` * Remove `/` from signatures (cherry picked from commit 7d21cae) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jan 23, 2024
…honGH-114425) * pythongh-101100: Fix sphinx warnings in `Doc/library/locale.rst` * Remove `/` from signatures (cherry picked from commit 7d21cae) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
|
GH-114477 is a backport of this pull request to the 3.12 branch. |
|
GH-114478 is a backport of this pull request to the 3.11 branch. |
|
Thank you! 🧹📚 |
aisk
pushed a commit
to aisk/cpython
that referenced
this pull request
Feb 11, 2024
…hon#114425) * pythongh-101100: Fix sphinx warnings in `Doc/library/locale.rst` * Remove `/` from signatures
Glyphack
pushed a commit
to Glyphack/cpython
that referenced
this pull request
Sep 2, 2024
…hon#114425) * pythongh-101100: Fix sphinx warnings in `Doc/library/locale.rst` * Remove `/` from signatures
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Before:
📚 Documentation preview 📚: https://cpython-previews--114425.org.readthedocs.build/