Skip to content

gh-104301: Tidy pdb documentation of exclamation prefix #104302

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Closed

Conversation

SnoopJ
Copy link
Contributor

@SnoopJ SnoopJ commented May 8, 2023

This changeset fixes #104301 by removing an errant space and adding an explicit example of using the prefix for disambiguation of built-in next from the pdb command of the same name


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

@SnoopJ
Copy link
Contributor Author

SnoopJ commented May 8, 2023

Edit: I attempted to fix the CI failure in a0124a2

Failure in CI appears to be due to the -W flag in the sphinx-build invocation, converting the following warning into a fatal error:

Warning: /home/runner/work/cpython/cpython/Doc/library/pdb.rst:607: WARNING: Could not lex literal_block as "python3". Highlighting skipped.

I think the code block in question may need an explicit declaration, but someone with better Sphinx skills than me can probably better spot what the fix for that is.

@AlexWaygood AlexWaygood requested a review from gaogaotiantian May 8, 2023 21:06
@iritkatriel
Copy link
Member

This can be close, right?

@SnoopJ
Copy link
Contributor Author

SnoopJ commented May 11, 2023

Yup, closing in favor of #104342

@SnoopJ SnoopJ closed this May 11, 2023
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
awaiting review docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Misleading documentation of ! prefix in pdb
3 participants