GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-104301: Tidy pdb documentation of exclamation prefix by SnoopJ · Pull Request #104302 · python/cpython

Conversation

@SnoopJ

@SnoopJ SnoopJ commented May 8, 2023 •
edited by github-actions Bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

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

  • Issue: Misleading documentation of ! prefix in pdb #104301

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
SnoopJ added 2 commits May 8, 2023 15:10
@SnoopJ
Drop misleading space
e75d604
@SnoopJ
Add example of exclamation mark prefix for disambiguation
1a427c5
@bedevere-bot bedevere-bot mentioned this pull request May 8, 2023
Misleading documentation of ! prefix in pdb #104301
Closed
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir skip news awaiting review labels May 8, 2023
@SnoopJ
Merge branch 'main' into doc/gh-104301_tidy-pdb-exclamation-doc
ccb678e
@SnoopJ

SnoopJ commented May 8, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor Author

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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
SnoopJ added 4 commits May 8, 2023 15:57
@SnoopJ
Use explicit code-block directives to disable syntax highlighting
a0124a2
@SnoopJ
Update duplicate copies of pdb documentation with new prefix explanation
38a1c75
@SnoopJ
Restore load-bearing double-quotes (oops)
ede5a5e
@SnoopJ
Correctly indent nested code-block directive
69a5a59
@AlexWaygood
AlexWaygood requested a review from gaogaotiantian May 8, 2023 21:06
@SnoopJ
Fix indentation in pydoc_data/topics
7bf224e
@SnoopJ SnoopJ mentioned this pull request May 9, 2023
gh-104301: Allow leading whitespace in disambiguated pdb statements #104342
Merged
@iritkatriel

iritkatriel commented May 11, 2023

Copy link
Copy Markdown
Member

This can be close, right?
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@SnoopJ

SnoopJ commented May 11, 2023

Copy link
Copy Markdown
Contributor Author

Yup, closing in favor of #104342
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@SnoopJ SnoopJ closed this May 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gaogaotiantian gaogaotiantian Awaiting requested review from gaogaotiantian gaogaotiantian is a code owner

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Misleading documentation of ! prefix in pdb

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@SnoopJ @iritkatriel @bedevere-bot
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.