Message396380
I made a proposal on discourse to redraft Doc/library/__main__.rst as it is currently quite terse and there have been a series of bpo's asking for more. See my discourse post:
https://discuss.python.org/t/proposed-overhaul-of-main-py-documentation-doc-library-main-rst/9344
================
There have been many complaints about the shortcoming of the documentation
towards informing users about __main__. Both the popular __name__ == '__main__' construct, and the role of __main__.py in a python module.
bpo-17359
bpo-24632
bpo-38452
I propose a broad overhaul of Doc/library/__main__.rst to address these
shortcomings and to provide a single source of truth on __main__ (in
general!). This is an appropriate place to put this information.
Both the __name__ == '__main__' and fooModule/__main__.py
constructs reasonably fall under the category of “Python Runtime Services,”
because they both control the way that programs run depending on how they are
used (command-line versus import versus running directly).
The new Doc/library/__main__.rst should have a new synopsis of, “CLIs,
import-time behavior, and if __name__ == ‘__main__’”, reflecting its new and
broader focus.
Additionally, the new docs should have the following distinct sections:
Differentiating between __name__ == ‘__main__’ and __main.__.py
__main__.py and the -m flag (this is roughly what is there already, although
it’s not as descriptive as it should be).
__name__ and the if __name__ == '__main__' construct.
If there is interest, I would be happy to open uptake this work on as soon as there is
consensus around this plan. I’m looking forward to hearing what you think!
================
Anyway, I have a first draft ready. I'm sure there will be plenty of feedback, so let it rip! I will open a GitHub PR and attach it to this bpo in just a moment. |
|
Date |
User |
Action |
Args |
2021-06-23 03:29:41 | jack__d | set | recipients:
+ jack__d, docs@python |
2021-06-23 03:29:41 | jack__d | set | messageid: <1624418981.72.0.882162459841.issue44494@roundup.psfhosted.org> |
2021-06-23 03:29:41 | jack__d | link | issue44494 messages |
2021-06-23 03:29:41 | jack__d | create | |
|