summaryrefslogtreecommitdiffstats
path: root/Doc/ref/ref6.tex
diff options
context:
space:
mode:
authorRaymond Hettinger <python@rcn.com>2003-01-06 12:54:54 (GMT)
committerRaymond Hettinger <python@rcn.com>2003-01-06 12:54:54 (GMT)
commit1772f176668dac4f1ad6aa425ecbc71a1fbcae73 (patch)
treea4ed770957601d0d9538f341accabde655ed0f7c /Doc/ref/ref6.tex
parentfb8595df4f9583ab9e83826cd782e0c18ba9cffa (diff)
downloadcpython-1772f176668dac4f1ad6aa425ecbc71a1fbcae73.zip
cpython-1772f176668dac4f1ad6aa425ecbc71a1fbcae73.tar.gz
cpython-1772f176668dac4f1ad6aa425ecbc71a1fbcae73.tar.bz2
SF bug #661848 and #631055: Clarify use of __all__.
Diffstat (limited to 'Doc/ref/ref6.tex')
-rw-r--r--Doc/ref/ref6.tex5
1 files changed, 4 insertions, 1 deletions
diff --git a/Doc/ref/ref6.tex b/Doc/ref/ref6.tex
index 9c088e9..6c252ed 100644
--- a/Doc/ref/ref6.tex
+++ b/Doc/ref/ref6.tex
@@ -702,7 +702,10 @@ imported by that module. The names given in \code{__all__} are all
considered public and are required to exist. If \code{__all__} is not
defined, the set of public names includes all names found in the
module's namespace which do not begin with an underscore character
-(\character{_}).
+(\character{_}). \code{__all__} should contain the entire public API.
+It is intended to avoid accidentally exporting items that are not part
+of the API (such as library modules which were imported and used within
+the module).
\withsubitem{(optional module attribute)}{\ttindex{__all__}}
The \keyword{from} form with \samp{*} may only occur in a module