[issue39712] Doc for `-X dev` option should mention PYTHONDEVMODE
New submission from Antoine Pitrou <pitrou@free.fr>: In the doc for `-X` options (https://docs.python.org/3/using/cmdline.html#id5), when an option can be triggered through an equivalent environment variable, that variable is mentioned. An exception to that is `-X dev`, which can also be triggered by the PYTHONDEVMODE variable, but that isn't mentioned in the CLI doc. Other missing environment variables in the CLI doc are PYTHONFAULTHANDLER and PYTHONTRACEMALLOC. ---------- assignee: docs@python components: Documentation keywords: easy, newcomer friendly messages: 362414 nosy: docs@python, eric.araujo, ezio.melotti, mdk, pitrou, vstinner, willingc priority: normal severity: normal stage: needs patch status: open title: Doc for `-X dev` option should mention PYTHONDEVMODE type: enhancement versions: Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39712> _______________________________________
Rahul Kumaresan <kayrahul@gmail.com> added the comment: I would like to work on this issue. Can you please suggest me specifics that I should be considering before I update the doc with the suggested inclusions. ---------- nosy: +rahul-kumi _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39712> _______________________________________
Change by Karthikeyan Singaravelan <tir.karthi@gmail.com>: ---------- nosy: +xtreak _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39712> _______________________________________
Change by Erlend Egeberg Aasland <erlend.aasland@innova.no>: ---------- keywords: +patch Added file: https://bugs.python.org/file48926/0001-bpo-39712.patch _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39712> _______________________________________
Change by Erlend Egeberg Aasland <erlend.aasland@innova.no>: Added file: https://bugs.python.org/file48927/0001-3.8-bpo-39712.patch _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39712> _______________________________________
Change by Erlend Egeberg Aasland <erlend.aasland@innova.no>: Added file: https://bugs.python.org/file48928/0001-3.7-bpo-39712.patch _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39712> _______________________________________
Change by Erlend Egeberg Aasland <erlend.aasland@innova.no>: ---------- nosy: +erlendaasland nosy_count: 9.0 -> 10.0 pull_requests: +18045 stage: needs patch -> patch review pull_request: https://github.com/python/cpython/pull/18685 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39712> _______________________________________
STINNER Victor <vstinner@python.org> added the comment:
An exception to that is `-X dev`, which can also be triggered by the PYTHONDEVMODE variable, but that isn't mentioned in the CLI doc.
I wrote a whole new page for -X dev: https://docs.python.org/dev/library/devmode.html#devmode This page starts with: "It can be enabled using the -X dev command line option or by setting the PYTHONDEVMODE environment variable to 1." ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39712> _______________________________________
Erlend Egeberg Aasland <erlend.aasland@innova.no> added the comment:
I wrote a whole new page for -X dev: https://docs.python.org/dev/library/devmode.html#devmode
That's nice, but references for PYTHONFAULTHANDLER and PYTHONTRACEMALLOC are still missing. If you think the cross refs for -X dev and PYTHONDEVMODE clutters cmdline.html, I'll remove them from the PR. Is it worth it adding https://docs.python.org/dev/library/devmode.html to 3.8 and possibly 3.7 as well? ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39712> _______________________________________
participants (5)
-
Antoine Pitrou -
Erlend Egeberg Aasland
-
Karthikeyan Singaravelan
-
Rahul Kumaresan
-
STINNER Victor