Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

gh-101100: Fix Sphinx warnings inlibrary/cmd.rst#113502

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

Merged
hugovk merged 5 commits intopython:mainfromhugovk:docs-fix-sphinx-warnings-cmd
Dec 27, 2023

Conversation

hugovk
Copy link
Member

@hugovkhugovk commentedDec 26, 2023•
edited
Loading

Fix 13 Sphinx warnings:

  • do_foo,complete_foo,help_bar anddo_bar,do_forward anddo_playback are examples, silence with!
  • There's already a paragraph aboutdo_help, let's add.. method:: Cmd.do_help(arg) so it can be linked to
  • Silencesys.stdout.write andsys.stdin.readline with!. Or is there somewhere good to link to?
  • cmdqueue was missing the class ref, change to~Cmd.cmdqueue
Doc/library/cmd.rst:78: WARNING: py:meth reference target not found: do_fooDoc/library/cmd.rst:78: WARNING: py:meth reference target not found: do_helpDoc/library/cmd.rst:78: WARNING: py:meth reference target not found: do_shellDoc/library/cmd.rst:88: WARNING: py:meth reference target not found: complete_fooDoc/library/cmd.rst:96: WARNING: py:meth reference target not found: do_helpDoc/library/cmd.rst:96: WARNING: py:meth reference target not found: help_barDoc/library/cmd.rst:96: WARNING: py:meth reference target not found: do_barDoc/library/cmd.rst:96: WARNING: py:meth reference target not found: do_helpDoc/library/cmd.rst:231: WARNING: py:meth reference target not found: sys.stdout.writeDoc/library/cmd.rst:231: WARNING: py:meth reference target not found: sys.stdin.readlineDoc/library/cmd.rst:251: WARNING: py:meth reference target not found: do_forwardDoc/library/cmd.rst:256: WARNING: py:meth reference target not found: do_playbackDoc/library/cmd.rst:256: WARNING: py:attr reference target not found: cmdqueue

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

Copy link
Member

@serhiy-storchakaserhiy-storchaka left a comment

Choose a reason for hiding this comment

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

LGTM. I have only doubts about silencingsys.stdout.write andsys.stdin.readline. Maybe add references tosys.stdout andsys.stdin?

AlexWaygood reacted with thumbs up emoji
@hugovk
Copy link
MemberAuthor

Sounds good, updated!

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Copy link
Member

@AlexWaygoodAlexWaygood left a comment

Choose a reason for hiding this comment

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

Nitpick: no need to link to the thing we're already reading (otherwise, this looks great!)

hugovk reacted with thumbs up emoji
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Copy link
Member

@AlexWaygoodAlexWaygood left a comment

Choose a reason for hiding this comment

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

LGTM!

@hugovkhugovk merged commit4acf825 intopython:mainDec 27, 2023
@hugovkhugovk deleted the docs-fix-sphinx-warnings-cmd branchDecember 27, 2023 10:17
@miss-islington-app
Copy link

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

@miss-islington-app
Copy link

Sorry,@hugovk, I could not cleanly backport this to3.12 due to a conflict.
Please backport usingcherry_picker on command line.

cherry_picker 4acf825058a7785ed3d66d4f5a4991298c011f64 3.12

miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestDec 27, 2023
…13502)(cherry picked from commit4acf825)Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-app
Copy link

GH-113510 is a backport of this pull request to the3.11 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.11only security fixes labelDec 27, 2023
@bedevere-app
Copy link

GH-113511 is a backport of this pull request to the3.12 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.12only security fixes labelDec 27, 2023
hugovk added a commit to hugovk/cpython that referenced this pull requestDec 27, 2023
…honGH-113502)(cherry picked from commit4acf825)Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
hugovk added a commit that referenced this pull requestDec 27, 2023
#113510)Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
hugovk added a commit that referenced this pull requestDec 27, 2023
#113511)Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
kulikjak pushed a commit to kulikjak/cpython that referenced this pull requestJan 22, 2024
)Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
aisk pushed a commit to aisk/cpython that referenced this pull requestFeb 11, 2024
)Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Glyphack pushed a commit to Glyphack/cpython that referenced this pull requestSep 2, 2024
)Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@serhiy-storchakaserhiy-storchakaserhiy-storchaka approved these changes

@AlexWaygoodAlexWaygoodAlexWaygood approved these changes

Assignees

@hugovkhugovk

Labels
docsDocumentation in the Doc dirskip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

3 participants
@hugovk@serhiy-storchaka@AlexWaygood
[8]ページ先頭
©2009-2025 Movatter.jp