Skip to content
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

Merged
merged 5 commits into from
Dec 27, 2023

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Dec 26, 2023

Fix 13 Sphinx warnings:

  • do_foo, complete_foo, help_bar and do_bar, do_forward and do_playback are examples, silence with !
  • There's already a paragraph about do_help, let's add .. method:: Cmd.do_help(arg) so it can be linked to
  • Silence sys.stdout.write and sys.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_foo
Doc/library/cmd.rst:78: WARNING: py:meth reference target not found: do_help
Doc/library/cmd.rst:78: WARNING: py:meth reference target not found: do_shell
Doc/library/cmd.rst:88: WARNING: py:meth reference target not found: complete_foo
Doc/library/cmd.rst:96: WARNING: py:meth reference target not found: do_help
Doc/library/cmd.rst:96: WARNING: py:meth reference target not found: help_bar
Doc/library/cmd.rst:96: WARNING: py:meth reference target not found: do_bar
Doc/library/cmd.rst:96: WARNING: py:meth reference target not found: do_help
Doc/library/cmd.rst:231: WARNING: py:meth reference target not found: sys.stdout.write
Doc/library/cmd.rst:231: WARNING: py:meth reference target not found: sys.stdin.readline
Doc/library/cmd.rst:251: WARNING: py:meth reference target not found: do_forward
Doc/library/cmd.rst:256: WARNING: py:meth reference target not found: do_playback
Doc/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-storchaka serhiy-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 silencing sys.stdout.write and sys.stdin.readline. Maybe add references to sys.stdout and sys.stdin?

@hugovk
Copy link
Member Author

hugovk commented Dec 27, 2023

Sounds good, updated!

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

@AlexWaygood AlexWaygood 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!)

Doc/library/cmd.rst Outdated Show resolved Hide resolved
Doc/library/cmd.rst Outdated Show resolved Hide resolved
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

LGTM!

@hugovk hugovk merged commit 4acf825 into python:main Dec 27, 2023
23 checks passed
@hugovk hugovk deleted the docs-fix-sphinx-warnings-cmd branch December 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 to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 4acf825058a7785ed3d66d4f5a4991298c011f64 3.12

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 27, 2023
…13502)

(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>
@bedevere-app
Copy link

bedevere-app bot commented Dec 27, 2023

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

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Dec 27, 2023
@bedevere-app
Copy link

bedevere-app bot commented Dec 27, 2023

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Dec 27, 2023
hugovk added a commit to hugovk/cpython that referenced this pull request Dec 27, 2023
…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>
hugovk added a commit that referenced this pull request Dec 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 request Dec 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 request Jan 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 request Feb 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 request Sep 2, 2024
)


Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants