[issue46279] [docs] Minor information-ordering issue in __main__ doc

FeRD (Frank Dana) report at bugs.python.org
Sat Jan 8 05:10:24 EST 2022


FeRD (Frank Dana) <ferdnyc at gmail.com> added the comment:

TBH, personally I don't think I'd just reword it with "below". That seems like the path of least resistance, but then the sentence becomes this:

"""
This won’t work for __main__.py files in the root directory of a .zip file though. Hence, for consistency, minimal __main__.py like the venv one mentioned below are preferred.
"""

Doesn't really track. How can you draw conclusions ("Hence...") from something that hasn't even been discussed yet?

It might actually be better to just drop the mention of venv from that particular sentence. The see-also text introduces *itself* as an example of what was just discussed. There's no real reason to bring it up ahead of time, because the see-also already flows naturally from the previous discussion without any setup.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue46279>
_______________________________________


More information about the Python-bugs-list mailing list