Skip to content

Commit de1279a

Browse files
Doc: update term "namespace package" (GH-129251)
(cherry picked from commit e65e9f9) Co-authored-by: Inada Naoki <[email protected]>
1 parent f23ed0c commit de1279a

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

Doc/glossary.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -873,11 +873,16 @@ Glossary
873873
modules, respectively.
874874

875875
namespace package
876-
A :pep:`420` :term:`package` which serves only as a container for
877-
subpackages. Namespace packages may have no physical representation,
876+
A :term:`package` which serves only as a container for subpackages.
877+
Namespace packages may have no physical representation,
878878
and specifically are not like a :term:`regular package` because they
879879
have no ``__init__.py`` file.
880880

881+
Namespace packages allow several individually installable packages to have a common parent package.
882+
Otherwise, it is recommended to use a :term:`regular package`.
883+
884+
For more information, see :pep:`420` and :ref:`reference-namespace-package`.
885+
881886
See also :term:`module`.
882887

883888
nested scope

Doc/reference/import.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,8 @@ Importing ``parent.one`` will implicitly execute ``parent/__init__.py`` and
123123
``parent/three/__init__.py`` respectively.
124124

125125

126+
.. _reference-namespace-package:
127+
126128
Namespace packages
127129
------------------
128130

0 commit comments

Comments
 (0)