Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32k
gh-101100: Fix sphinx warnings inDoc/library/locale.rst#114425
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Doc/library/locale.rst Outdated
| .. 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Actual functions inlocale 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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.
…honGH-114425)*pythongh-101100: Fix sphinx warnings in `Doc/library/locale.rst`* Remove `/` from signatures(cherry picked from commit7d21cae)Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
…honGH-114425)*pythongh-101100: Fix sphinx warnings in `Doc/library/locale.rst`* Remove `/` from signatures(cherry picked from commit7d21cae)Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
GH-114477 is a backport of this pull request to the3.12 branch. |
GH-114478 is a backport of this pull request to the3.11 branch. |
Thank you! 🧹📚 |
…hon#114425)*pythongh-101100: Fix sphinx warnings in `Doc/library/locale.rst`* Remove `/` from signatures
…hon#114425)*pythongh-101100: Fix sphinx warnings in `Doc/library/locale.rst`* Remove `/` from signatures
Uh oh!
There was an error while loading.Please reload this page.
Before:
📚 Documentation preview 📚:https://cpython-previews--114425.org.readthedocs.build/