FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-101100: Fix sphinx warnings in `Doc/library/locale.rst` by sobolevn · Pull Request #114425 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-101100: Fix sphinx warnings in Doc/library/locale.rst - #114425

Merged
hugovk merged 2 commits into
python:mainfrom
sobolevn:issue-101100-locale
Jan 23, 2024
ConversationCommits (2)ChecksFiles changed
Merged

gh-101100: Fix sphinx warnings in Doc/library/locale.rst#114425
hugovk merged 2 commits into
python:mainfrom
sobolevn:issue-101100-locale

Conversation

sobolevn commented Jan 22, 2024 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

Before:

/Users/sobolev/Desktop/cpython2/Doc/library/locale.rst:21: WARNING: py:mod reference target not found: _locale
/Users/sobolev/Desktop/cpython2/Doc/library/locale.rst:201: WARNING: py:const reference target not found: DAY_1
/Users/sobolev/Desktop/cpython2/Doc/library/locale.rst:237: WARNING: c:func reference target not found: regex
/Users/sobolev/Desktop/cpython2/Doc/library/locale.rst:582: WARNING: py:mod reference target not found: _locale
/Users/sobolev/Desktop/cpython2/Doc/library/locale.rst:582: WARNING: py:mod reference target not found: _locale
/Users/sobolev/Desktop/cpython2/Doc/library/locale.rst:608: WARNING: c:func reference target not found: gettext
/Users/sobolev/Desktop/cpython2/Doc/library/locale.rst:608: WARNING: c:func reference target not found: dcgettext

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

sobolevn requested a review from hugovk January 22, 2024 11:26
bedevere-app Bot added awaiting review docs Documentation in the Doc dir skip news labels Jan 22, 2024
bedevere-app Bot mentioned this pull request Jan 22, 2024
Closed
sobolevn added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes docs Documentation in the Doc dir and removed docs Documentation in the Doc dir labels Jan 22, 2024
hugovk reviewed Jan 22, 2024
View reviewed changes
Comment thread 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, /)

hugovk Jan 22, 2024

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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?

sobolevn Jan 22, 2024 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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?

hugovk Jan 22, 2024

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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.

hugovk merged commit 7d21cae into python:main Jan 23, 2024

miss-islington-app Bot commented Jan 23, 2024

Copy link
Copy Markdown

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 23, 2024
pythongh-101100: Fix sphinx warnings in Doc/library/locale.rst (pyt…
ee390c3 
…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
pythongh-101100: Fix sphinx warnings in Doc/library/locale.rst (pyt…
26706be 
…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>

bedevere-app Bot commented Jan 23, 2024

Copy link
Copy Markdown

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

bedevere-app Bot removed the needs backport to 3.12 only security fixes label Jan 23, 2024

bedevere-app Bot commented Jan 23, 2024

Copy link
Copy Markdown

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

bedevere-app Bot removed the needs backport to 3.11 only security fixes label Jan 23, 2024

hugovk commented Jan 23, 2024

Copy link
Copy Markdown
Member

Thank you! 🧹📚

hugovk pushed a commit that referenced this pull request Jan 23, 2024
[3.12] gh-101100: Fix sphinx warnings in Doc/library/locale.rst (GH…
1b9abe4 
…-114425) (#114477)

gh-101100: Fix sphinx warnings in `Doc/library/locale.rst` (GH-114425)

* gh-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>
hugovk pushed a commit that referenced this pull request Jan 23, 2024
[3.11] gh-101100: Fix sphinx warnings in Doc/library/locale.rst (GH…
b62db46 
…-114425) (#114478)

gh-101100: Fix sphinx warnings in `Doc/library/locale.rst` (GH-114425)

* gh-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>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
pythongh-101100: Fix sphinx warnings in Doc/library/locale.rst (pyt…
68c7d7c 
…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
pythongh-101100: Fix sphinx warnings in Doc/library/locale.rst (pyt…
ff49049 
…hon#114425)

* pythongh-101100: Fix sphinx warnings in `Doc/library/locale.rst`

* Remove `/` from signatures
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

hugovk hugovk left review comments

Assignees

No one assigned

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

Back | FazBrowse Home | New Git URL