-
-
Notifications
You must be signed in to change notification settings - Fork 30.9k
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
gh-101100: Fix Sphinx warnings in library/cmd.rst
#113502
Conversation
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.
LGTM. I have only doubts about silencing sys.stdout.write
and sys.stdin.readline
. Maybe add references to sys.stdout
and sys.stdin
?
Sounds good, updated! |
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
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.
Nitpick: no need to link to the thing we're already reading (otherwise, this looks great!)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
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.
LGTM!
Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12. |
Sorry, @hugovk, I could not cleanly backport this to
|
GH-113510 is a backport of this pull request to the 3.11 branch. |
GH-113511 is a backport of this pull request to the 3.12 branch. |
…honGH-113502) (cherry picked from commit 4acf825) 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>
#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>
#113511) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Fix 13 Sphinx warnings:
do_foo
,complete_foo
,help_bar
anddo_bar
,do_forward
anddo_playback
are examples, silence with!
do_help
, let's add.. method:: Cmd.do_help(arg)
so it can be linked tosys.stdout.write
andsys.stdin.readline
with!
. Or is there somewhere good to link to?cmdqueue
was missing the class ref, change to~Cmd.cmdqueue
📚 Documentation preview 📚: https://cpython-previews--113502.org.readthedocs.build/