◐ Shell
reader mode source ↗
Skip to content

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

Merged
hugovk merged 5 commits into
python:mainfrom
hugovk:docs-fix-sphinx-warnings-cmd
Dec 27, 2023
Merged

gh-101100: Fix Sphinx warnings in library/cmd.rst#113502
hugovk merged 5 commits into
python:mainfrom
hugovk:docs-fix-sphinx-warnings-cmd

Conversation

@hugovk

@hugovk hugovk commented Dec 26, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

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/

@bedevere-app bedevere-app Bot mentioned this pull request Dec 26, 2023
Open
serhiy-storchaka
serhiy-storchaka approved these changes Dec 27, 2023
View reviewed changes

@serhiy-storchaka serhiy-storchaka left a comment

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.

Hide comment

LGTM. I have only doubts about silencing sys.stdout.write and sys.stdin.readline. Maybe add references to sys.stdout and sys.stdin?

@hugovk

hugovk commented Dec 27, 2023

Copy link
Copy Markdown
Member Author

Sounds good, updated!

@hugovk @serhiy-storchaka
Add brackets …
32eec77 
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
AlexWaygood
AlexWaygood reviewed Dec 27, 2023
View reviewed changes

@AlexWaygood AlexWaygood left a comment

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.

Hide comment

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

@hugovk @AlexWaygood
Don't link to do_help from do_help …
5fba9dd 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
AlexWaygood
AlexWaygood approved these changes Dec 27, 2023
View reviewed changes

@AlexWaygood AlexWaygood left a comment

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.

Hide comment

LGTM!

@hugovk hugovk merged commit 4acf825 into python:main Dec 27, 2023
@hugovk hugovk deleted the docs-fix-sphinx-warnings-cmd branch December 27, 2023 10:17
@miss-islington-app

miss-islington-app Bot commented Dec 27, 2023

Copy link
Copy Markdown

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

@miss-islington-app

miss-islington-app Bot commented Dec 27, 2023

Copy link
Copy Markdown

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
@hugovk @serhiy-storchaka
@AlexWaygood @miss-islington
pythongh-101100: Fix Sphinx warnings in library/cmd.rst (pythonGH-1… …
ebffc71 
…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

bedevere-app Bot commented Dec 27, 2023

Copy link
Copy Markdown

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

bedevere-app Bot commented Dec 27, 2023

Copy link
Copy Markdown

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

hugovk added a commit to hugovk/cpython that referenced this pull request Dec 27, 2023
@hugovk @serhiy-storchaka @AlexWaygood
[3.12] pythongh-101100: Fix Sphinx warnings in library/cmd.rst (pyt… …
fa748ac 
…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
@miss-islington @hugovk
@serhiy-storchaka @AlexWaygood
[3.11] gh-101100: Fix Sphinx warnings in library/cmd.rst (GH-113502) ( …
050d50a 
#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
@hugovk @serhiy-storchaka @AlexWaygood
[3.12] gh-101100: Fix Sphinx warnings in library/cmd.rst (GH-113502) ( …
6177a85 
#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
@hugovk @serhiy-storchaka
@AlexWaygood @kulikjak
pythongh-101100: Fix Sphinx warnings in library/cmd.rst (python#113502 …
db5ca8a 
)


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
@hugovk @serhiy-storchaka
@AlexWaygood @aisk
pythongh-101100: Fix Sphinx warnings in library/cmd.rst (python#113502 …
c54049d 
)


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
@hugovk @serhiy-storchaka
@AlexWaygood @Glyphack
pythongh-101100: Fix Sphinx warnings in library/cmd.rst (python#113502 …
7c7d43e 
)


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

Reviewers

@serhiy-storchaka serhiy-storchaka serhiy-storchaka approved these changes

@AlexWaygood AlexWaygood

Assignees

@hugovk hugovk

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.

3 participants

@hugovk @serhiy-storchaka @AlexWaygood