]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
better __init__.py explanation in tutorial (GH-12763)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Thu, 11 Apr 2019 06:16:34 +0000 (23:16 -0700)
committerGitHub <noreply@github.com>
Thu, 11 Apr 2019 06:16:34 +0000 (23:16 -0700)
* better __init__.py explanation in tutorial

* Update Doc/tutorial/modules.rst

Co-Authored-By: methane <songofacandy@gmail.com>
(cherry picked from commit 5410d3d283b11e2375f0c1f79728a230edd12bd0)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
Doc/tutorial/modules.rst

index accc30649f24effdd19a639bd6acbcdbbbd43d24..fd594fd97af4d4608e4089fc67a8eaf5a9c0354e 100644 (file)
@@ -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.