Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 027223d

Browse files
Update pdb docs for arguments (#102965)
1 parent 11ed70b commit 027223d

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

Doc/library/pdb.rst

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ slightly different way:
125125

126126
Evaluate the *expression* (given as a string or a code object) under debugger
127127
control. When :func:`runeval` returns, it returns the value of the
128-
expression. Otherwise this function is similar to :func:`run`.
128+
*expression*. Otherwise this function is similar to :func:`run`.
129129

130130

131131
.. function:: runcall(function, *args, **kwds)
@@ -178,7 +178,7 @@ access further features, you have to do this yourself:
178178
that matches one of these patterns. [1]_
179179

180180
By default, Pdb sets a handler for the SIGINT signal (which is sent when the
181-
user presses :kbd:`Ctrl-C` on the console) when you give a ``continue`` command.
181+
user presses :kbd:`Ctrl-C` on the console) when you give a :pdbcmd:`continue` command.
182182
This allows you to break into the debugger again by pressing :kbd:`Ctrl-C`. If you
183183
want Pdb not to touch the SIGINT handler, set *nosigint* to true.
184184

@@ -328,9 +328,9 @@ can be overridden by the local file.
328328

329329
.. pdbcommand:: ignore bpnumber [count]
330330

331-
Set the ignore count for the given breakpoint number. If count is omitted,
331+
Set the ignore count for the given breakpoint number. If *count* is omitted,
332332
the ignore count is set to 0. A breakpoint becomes active when the ignore
333-
count is zero. When non-zero, the count is decremented each time the
333+
count is zero. When non-zero, the *count* is decremented each time the
334334
breakpoint is reached and the breakpoint is not disabled and any associated
335335
condition evaluates to true.
336336

@@ -369,7 +369,7 @@ can be overridden by the local file.
369369
breakpoint—which could have its own command list, leading to ambiguities about
370370
which list to execute.
371371

372-
If you use the 'silent' command in the command list, the usual message about
372+
If you use the ``silent`` command in the command list, the usual message about
373373
stopping at a breakpoint is not printed. This may be desirable for breakpoints
374374
that are to print a specific message and then continue. If none of the other
375375
commands print anything, you see no sign that the breakpoint was reached.
@@ -392,8 +392,8 @@ can be overridden by the local file.
392392
Without argument, continue execution until the line with a number greater
393393
than the current one is reached.
394394

395-
With a line number, continue execution until a line with a number greater or
396-
equal to that is reached. In both cases, also stop when the current frame
395+
With *lineno*, continue execution until a line with a number greater or
396+
equal to *lineno* is reached. In both cases, also stop when the current frame
397397
returns.
398398

399399
.. versionchanged:: 3.2
@@ -446,7 +446,7 @@ can be overridden by the local file.
446446

447447
.. pdbcommand:: p expression
448448

449-
Evaluate the *expression* in the current context and print its value.
449+
Evaluate *expression* in the current context and print its value.
450450

451451
.. note::
452452

@@ -456,32 +456,32 @@ can be overridden by the local file.
456456

457457
.. pdbcommand:: pp expression
458458

459-
Like the :pdbcmd:`p` command, except the value of the expression is
459+
Like the :pdbcmd:`p` command, except the value of *expression* is
460460
pretty-printed using the :mod:`pprint` module.
461461

462462
.. pdbcommand:: whatis expression
463463

464-
Print the type of the *expression*.
464+
Print the type of *expression*.
465465

466466
.. pdbcommand:: source expression
467467

468-
Try to get source code for the given object and display it.
468+
Try to get source code of *expression* and display it.
469469

470470
.. versionadded:: 3.2
471471

472472
.. pdbcommand:: display [expression]
473473

474-
Display the value of the expression if it changed, each time execution stops
474+
Display the value of *expression* if it changed, each time execution stops
475475
in the current frame.
476476

477-
Without expression, list all display expressions for the current frame.
477+
Without *expression*, list all display expressions for the current frame.
478478

479479
.. versionadded:: 3.2
480480

481481
.. pdbcommand:: undisplay [expression]
482482

483-
Do not display the expression any more in the current frame. Without
484-
expression, clear all display expressions for the current frame.
483+
Do not display *expression* anymore in the current frame. Without
484+
*expression*, clear all display expressions for the current frame.
485485

486486
.. versionadded:: 3.2
487487

@@ -497,10 +497,10 @@ can be overridden by the local file.
497497

498498
.. pdbcommand:: alias [name [command]]
499499

500-
Create an alias called *name* that executes *command*. The command must
500+
Create an alias called *name* that executes *command*. The *command* must
501501
*not* be enclosed in quotes. Replaceable parameters can be indicated by
502502
``%1``, ``%2``, and so on, while ``%*`` is replaced by all the parameters.
503-
If no command is given, the current alias for *name* is shown. If no
503+
If *command* is omitted, the current alias for *name* is shown. If no
504504
arguments are given, all aliases are listed.
505505

506506
Aliases may be nested and can contain anything that can be legally typed at
@@ -519,7 +519,7 @@ can be overridden by the local file.
519519

520520
.. pdbcommand:: unalias name
521521

522-
Delete the specified alias.
522+
Delete the specified alias *name*.
523523

524524
.. pdbcommand:: ! statement
525525

@@ -535,7 +535,7 @@ can be overridden by the local file.
535535
.. pdbcommand:: run [args ...]
536536
restart [args ...]
537537

538-
Restart the debugged Python program. If an argument is supplied, it is split
538+
Restart the debugged Python program. If *args* is supplied, it is split
539539
with :mod:`shlex` and the result is used as the new :data:`sys.argv`.
540540
History, breakpoints, actions and debugger options are preserved.
541541
:pdbcmd:`restart` is an alias for :pdbcmd:`run`.
@@ -546,8 +546,8 @@ can be overridden by the local file.
546546

547547
.. pdbcommand:: debug code
548548

549-
Enter a recursive debugger that steps through the code
550-
argument (which is an arbitrary expression or statement to be
549+
Enter a recursive debugger that steps through *code*
550+
(which is an arbitrary expression or statement to be
551551
executed in the current environment).
552552

553553
.. pdbcommand:: retval

0 commit comments

Comments
 (0)