Skip to content

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

Closed
SnoopJ wants to merge 8 commits into
python:mainfrom
SnoopJ:doc/gh-104301_tidy-pdb-exclamation-doc
Closed

gh-104301: Tidy pdb documentation of exclamation prefix#104302
SnoopJ wants to merge 8 commits into
python:mainfrom
SnoopJ:doc/gh-104301_tidy-pdb-exclamation-doc

Conversation

@SnoopJ

@SnoopJSnoopJ commented May 8, 2023

Copy link
Copy Markdown
Contributor

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

SnoopJ commented May 8, 2023

Copy link
Copy Markdown
ContributorAuthor

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.

@iritkatriel

Copy link
Copy Markdown
Member

This can be close, right?

@SnoopJ

Copy link
Copy Markdown
ContributorAuthor

Yup, closing in favor of #104342

@SnoopJSnoopJ closed this May 11, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting reviewdocsDocumentation in the Doc dirskip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Misleading documentation of ! prefix in pdb

3 participants

@SnoopJ@iritkatriel@bedevere-bot