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

FeRD (Frank Dana) report at bugs.python.org
Thu Jan 6 07:57:08 EST 2022


New submission from FeRD (Frank Dana) <ferdnyc at gmail.com>:

The expanded documentation on top-level environments is quite an improvement, but there's one passage that causes some confusion. In the section '__main__.py in Python Packages', towards the end, it reads:

"""
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 above are preferred.
"""

Problem is, that's the first mention of venv anywhere in the document. There's a 'See also:' box right BELOW the sentence in question that references venv and its minimal __main__.py, but it hasn't been introduced yet when that first mention comes along.

----------
assignee: docs at python
components: Documentation
messages: 409839
nosy: docs at python, ferdnyc
priority: normal
severity: normal
status: open
title: [docs] Minor information-ordering issue in __main__ doc
versions: Python 3.11

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


More information about the New-bugs-announce mailing list