FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-104301: Tidy pdb documentation of exclamation prefix by SnoopJ · Pull Request #104302 · python/cpython · GitHub

/ cpython Public

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

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.

Sign up for GitHub

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

Closed
SnoopJ wants to merge 8 commits into from
Conversation 3 Commits 8 Checks 0 Files changed
Closed

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e75d604
Drop misleading space
SnoopJ May 8, 2023
1a427c5
Add example of exclamation mark prefix for disambiguation
SnoopJ May 8, 2023
ccb678e
Merge branch 'main' into doc/gh-104301_tidy-pdb-exclamation-doc
SnoopJ May 8, 2023
a0124a2
Use explicit code-block directives to disable syntax highlighting
SnoopJ May 8, 2023
38a1c75
Update duplicate copies of pdb documentation with new prefix explanation
SnoopJ May 8, 2023
ede5a5e
Restore load-bearing double-quotes (oops)
SnoopJ May 8, 2023
69a5a59
Correctly indent nested code-block directive
SnoopJ May 8, 2023
7bf224e
Fix indentation in pydoc_data/topics
SnoopJ May 8, 2023
File filter

Filter by extension

Filter by extension .py  (2) .rst  (1) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
17 changes: 13 additions & 4 deletions Doc/library/pdb.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -598,13 +598,22 @@ can be overridden by the local file.

Delete the specified alias *name*.

.. pdbcommand:: ! statement
.. pdbcommand:: !statement

Execute the (one-line) *statement* in the context of the current stack frame.
The exclamation point can be omitted unless the first word of the statement
resembles a debugger command. To set a global variable, you can prefix the
assignment command with a :keyword:`global` statement on the same line,
e.g.::
resembles a debugger command, e.g.:

.. code-block:: none

(Pdb) !next(some_iterator)
42
(Pdb)

To set a global variable, you can prefix the assignment command with a
:keyword:`global` statement on the same line, e.g.:

.. code-block:: none

(Pdb) global list_options; list_options = ['-l']
(Pdb)
Expand Down
12 changes: 8 additions & 4 deletions Lib/pdb.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -1638,13 +1638,17 @@ def do_help(self, arg):
do_h = do_help

def help_exec(self):
"""(!) statement
"""(!)statement

Execute the (one-line) statement in the context of the current
stack frame. The exclamation point can be omitted unless the
first word of the statement resembles a debugger command. To
assign to a global variable you must always prefix the command
with a 'global' command, e.g.:
first word of the statement resembles a debugger command, e.g.:
(Pdb) !next(some_iterator)
42
(Pdb)

To assign to a global variable you must always prefix the command with
a 'global' command, e.g.:
(Pdb) global list_options; list_options = ['-l']
(Pdb)
"""
Expand Down
16 changes: 10 additions & 6 deletions Lib/pydoc_data/topics.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -5277,17 +5277,21 @@
'\n'
' Delete the specified alias *name*.\n'
'\n'
'! statement\n'
'!statement\n'
'\n'
' Execute the (one-line) *statement* in the context of the '
'current\n'
' stack frame. The exclamation point can be omitted unless the '
'first\n'
' word of the statement resembles a debugger command. To set '
'a\n'
' global variable, you can prefix the assignment command with '
'a\n'
' "global" statement on the same line, e.g.:\n'
' word of the statement resembles a debugger command, e.g.:'
'\n'
' (Pdb) !next(some_iterator)\n'
' 42\n'
' (Pdb)\n'
'\n'
' To set a global variable, you can prefix the assignment command '
' with \n'
' a "global" statement on the same line, e.g.:\n'
'\n'
" (Pdb) global list_options; list_options = ['-l']\n"
' (Pdb)\n'
Expand Down
Back | FazBrowse Home | New Git URL