[issue13474] Mention of "-m" Flag Missing From Doc on Execution Model
New submission from Eric Snow <ericsnowcurrently@gmail.com>: The doc on code execution[1] leaves out mention of the -m flag. Seems like it belongs there too. [1] Doc/reference/executionmodel.rst ---------- assignee: docs@python components: Documentation messages: 148288 nosy: docs@python, eric.snow priority: normal severity: normal status: open title: Mention of "-m" Flag Missing From Doc on Execution Model versions: Python 2.7, Python 3.2, Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue13474> _______________________________________
Changes by Ezio Melotti <ezio.melotti@gmail.com>: ---------- nosy: +ezio.melotti stage: -> needs patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue13474> _______________________________________
Éric Araujo <merwok@netwok.org> added the comment: I guess you’re suggesting adding a mention of -m in the section near the top that says that a script file and code passed to -c are blocks? Makes sense. The same commit could also improve the markup to link to the description of script, -c and -m in using/cmdline. (I think we have another doc bug open about cross-linking using/cmdline and other parts, but I don’t have the number at hand.) ---------- nosy: +eric.araujo, ncoghlan _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue13474> _______________________________________
Change by Cheryl Sabella <chekat2@gmail.com>: ---------- keywords: +easy type: -> enhancement versions: +Python 3.7, Python 3.8 -Python 3.2, Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue13474> _______________________________________
Change by Hamish MacDonald <elusivenode@gmail.com>: ---------- keywords: +patch pull_requests: +6570 stage: needs patch -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue13474> _______________________________________
Change by Hamish MacDonald <elusivenode@gmail.com>: ---------- pull_requests: +6571 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue13474> _______________________________________
Nick Coghlan <ncoghlan@gmail.com> added the comment: I've assigned the PR and issue to myself, as the proposed addition in the PR isn't quite right, but it isn't immediately obvious why not. The gist of the problem is that the current docs are actually correct and complete: modules are the first thing listed as being code blocks, and whether you import them or execute them as __main__ doesn't change that. However, I can also see why 2011-Eric thought it looked incomplete, so I'm thinking it may make sense to restructure that entire paragraph as a bulleted list, where it would be possible to mention both imported modules and modules executed as main, without giving the impression that those are inherently different things. ---------- assignee: docs@python -> ncoghlan _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue13474> _______________________________________
Change by Steve Dower <steve.dower@python.org>: ---------- keywords: -easy _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue13474> _______________________________________
Change by Cheryl Sabella <cheryl.sabella@gmail.com>: ---------- nosy: +cheryl.sabella _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue13474> _______________________________________
Change by Julien Palard <julien+python@palard.fr>: ---------- pull_requests: +15667 pull_request: https://github.com/python/cpython/pull/16045 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue13474> _______________________________________
Change by Julien Palard <julien+python@palard.fr>: ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue13474> _______________________________________
participants (8)
-
Cheryl Sabella
-
Eric Snow
-
Ezio Melotti
-
Hamish MacDonald
-
Julien Palard
-
Nick Coghlan
-
Steve Dower
-
Éric Araujo