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

Skip to content

Commit f5334ae

Browse files
SantiagoCarreau
authored andcommitted
doc: clarify xmode docstring with mode descriptions
1 parent 98de7b8 commit f5334ae

1 file changed

Lines changed: 13 additions & 3 deletions

File tree

IPython/core/magics/basic.py

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -346,9 +346,19 @@ def xmode(self, parameter_s=''):
346346
347347
Valid modes: Plain, Context, Verbose, Minimal, and Docs.
348348
349-
If called without arguments, acts as a toggle.
350-
351-
When in verbose mode the value `--show` (and `--hide`)
349+
- ``Plain``: similar to Python's default traceback.
350+
- ``Context``: shows several lines of surrounding context for each
351+
frame in the traceback.
352+
- ``Verbose``: like Context, but also displays local variable values
353+
in each frame.
354+
- ``Minimal``: shows only the exception type and message, without
355+
a traceback.
356+
- ``Docs``: a stripped-down version of Verbose, designed for use
357+
when running doctests.
358+
359+
If called without arguments, cycles through the available modes.
360+
361+
When in verbose mode the value ``--show`` (and ``--hide``)
352362
will respectively show (or hide) frames with ``__tracebackhide__ =
353363
True`` value set.
354364
"""

0 commit comments

Comments
 (0)