summaryrefslogtreecommitdiffstats
path: root/Doc/using/cmdline.rst
diff options
context:
space:
mode:
authorVictor Stinner <victor.stinner@gmail.com>2017-11-21 02:59:50 (GMT)
committerGitHub <noreply@github.com>2017-11-21 02:59:50 (GMT)
commitbc9b6e29cb52f8da15613f9174af2f603131b56d (patch)
tree87fdd957feefa292457ac25c7f71c9288ade7790 /Doc/using/cmdline.rst
parent25420fe290b98171e6d30edf9350292c21ef700e (diff)
downloadcpython-bc9b6e29cb52f8da15613f9174af2f603131b56d.zip
cpython-bc9b6e29cb52f8da15613f9174af2f603131b56d.tar.gz
cpython-bc9b6e29cb52f8da15613f9174af2f603131b56d.tar.bz2
bpo-32043: Rephrase -X dev documentation (#4478)
* should not be more verbose if the code is correct * enabled checks can be "expensive"
Diffstat (limited to 'Doc/using/cmdline.rst')
-rw-r--r--Doc/using/cmdline.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst
index 8e186b3..fc557ee 100644
--- a/Doc/using/cmdline.rst
+++ b/Doc/using/cmdline.rst
@@ -411,8 +411,10 @@ Miscellaneous options
nested imports). Note that its output may be broken in multi-threaded
application. Typical usage is ``python3 -X importtime -c 'import
asyncio'``. See also :envvar:`PYTHONPROFILEIMPORTTIME`.
- * ``-X dev`` enables the "developer mode": enable debug checks at runtime.
- Developer mode:
+ * ``-X dev``: enable CPython's "developer mode", introducing additional
+ runtime checks which are too expensive to be enabled by default. It should
+ not be more verbose than the default if the code is correct: new warnings
+ are only emitted when an issue is detected. Effect of the developer mode:
* Warning filters: add a filter to display all warnings (``"default"``
action), except of :exc:`BytesWarning` which still depends on the
@@ -441,8 +443,7 @@ Miscellaneous options
The ``-X showalloccount`` option.
.. versionadded:: 3.7
- The ``-X importtime``, ``-X dev`` and :envvar:`PYTHONPROFILEIMPORTTIME`
- options.
+ The ``-X importtime`` and ``-X dev`` options.
Options you shouldn't use