Skip to content

Commit 692d36f

Browse files
Doc: update term "namespace package" (GH-129251)
(cherry picked from commit e65e9f9)
1 parent e5ee784 commit 692d36f

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
@@ -926,11 +926,16 @@ Glossary
926926
modules, respectively.
927927

928928
namespace package
929-
A :pep:`420` :term:`package` which serves only as a container for
930-
subpackages. Namespace packages may have no physical representation,
929+
A :term:`package` which serves only as a container for subpackages.
930+
Namespace packages may have no physical representation,
931931
and specifically are not like a :term:`regular package` because they
932932
have no ``__init__.py`` file.
933933

934+
Namespace packages allow several individually installable packages to have a common parent package.
935+
Otherwise, it is recommended to use a :term:`regular package`.
936+
937+
For more information, see :pep:`420` and :ref:`reference-namespace-package`.
938+
934939
See also :term:`module`.
935940

936941
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)