summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorInada Naoki <songofacandy@gmail.com>2019-04-11 06:10:35 (GMT)
committerGitHub <noreply@github.com>2019-04-11 06:10:35 (GMT)
commit5410d3d283b11e2375f0c1f79728a230edd12bd0 (patch)
treefa68565fc51b18cea7d1dcedecdd8e6823324b14 /Doc
parentb5e2959b27088d39f9954a207b91ab0ebbd149f4 (diff)
downloadcpython-5410d3d283b11e2375f0c1f79728a230edd12bd0.zip
cpython-5410d3d283b11e2375f0c1f79728a230edd12bd0.tar.gz
cpython-5410d3d283b11e2375f0c1f79728a230edd12bd0.tar.bz2
better __init__.py explanation in tutorial (#12763)
* better __init__.py explanation in tutorial * Update Doc/tutorial/modules.rst Co-Authored-By: methane <songofacandy@gmail.com>
Diffstat (limited to 'Doc')
-rw-r--r--Doc/tutorial/modules.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/tutorial/modules.rst b/Doc/tutorial/modules.rst
index accc306..fd594fd 100644
--- a/Doc/tutorial/modules.rst
+++ b/Doc/tutorial/modules.rst
@@ -425,9 +425,9 @@ your package (expressed in terms of a hierarchical filesystem):
When importing the package, Python searches through the directories on
``sys.path`` looking for the package subdirectory.
-The :file:`__init__.py` files are required to make Python treat the directories
-as containing packages; this is done to prevent directories with a common name,
-such as ``string``, from unintentionally hiding valid modules that occur later
+The :file:`__init__.py` files are required to make Python treat directories
+containing the file as packages. This prevents directories with a common name,
+such as ``string``, unintentionally hiding valid modules that occur later
on the module search path. In the simplest case, :file:`__init__.py` can just be
an empty file, but it can also execute initialization code for the package or
set the ``__all__`` variable, described later.