summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRandy <69558016+san-juan1667@users.noreply.github.com>2023-04-22 23:33:50 (GMT)
committerGitHub <noreply@github.com>2023-04-22 23:33:50 (GMT)
commit7bf94568a9a4101c72b8bf555a811028e5b45ced (patch)
tree7de160790ad60d510bfb7b751ee1c9b538cdba76
parent8cb2b0f953288ff8749e686c268097cdd5a393e2 (diff)
downloadcpython-7bf94568a9a4101c72b8bf555a811028e5b45ced.zip
cpython-7bf94568a9a4101c72b8bf555a811028e5b45ced.tar.gz
cpython-7bf94568a9a4101c72b8bf555a811028e5b45ced.tar.bz2
gh-68654: Clarify subdirectories used by pkgutil.extend_path (#103701)
Clarify sub directories used by pkgutil.extend_path in the docs and the docstring
-rw-r--r--Doc/library/pkgutil.rst6
-rw-r--r--Lib/pkgutil.py8
2 files changed, 7 insertions, 7 deletions
diff --git a/Doc/library/pkgutil.rst b/Doc/library/pkgutil.rst
index 788a02d..66d753b 100644
--- a/Doc/library/pkgutil.rst
+++ b/Doc/library/pkgutil.rst
@@ -25,9 +25,9 @@ support.
from pkgutil import extend_path
__path__ = extend_path(__path__, __name__)
- This will add to the package's ``__path__`` all subdirectories of directories
- on :data:`sys.path` named after the package. This is useful if one wants to
- distribute different parts of a single logical package as multiple
+ For each directory on :data:`sys.path` that has a subdirectory that matches the
+ package name, add the subdirectory to the package's :attr:`__path__`. This is useful
+ if one wants to distribute different parts of a single logical package as multiple
directories.
It also looks for :file:`\*.pkg` files beginning where ``*`` matches the
diff --git a/Lib/pkgutil.py b/Lib/pkgutil.py
index bdebfd2..56731de 100644
--- a/Lib/pkgutil.py
+++ b/Lib/pkgutil.py
@@ -511,10 +511,10 @@ def extend_path(path, name):
from pkgutil import extend_path
__path__ = extend_path(__path__, __name__)
- This will add to the package's __path__ all subdirectories of
- directories on sys.path named after the package. This is useful
- if one wants to distribute different parts of a single logical
- package as multiple directories.
+ For each directory on sys.path that has a subdirectory that
+ matches the package name, add the subdirectory to the package's
+ __path__. This is useful if one wants to distribute different
+ parts of a single logical package as multiple directories.
It also looks for *.pkg files beginning where * matches the name
argument. This feature is similar to *.pth files (see site.py),