]> granicus.if.org Git - python/commitdiff
SF bug #661848 and #631055: Clarify use of __all__.
authorRaymond Hettinger <python@rcn.com>
Mon, 6 Jan 2003 12:54:54 +0000 (12:54 +0000)
committerRaymond Hettinger <python@rcn.com>
Mon, 6 Jan 2003 12:54:54 +0000 (12:54 +0000)
Doc/ref/ref6.tex

index 9c088e912e83296fe49ad98d0fc3d888a9e4bc1c..6c252ed37c3bc4940486c8e32ca342e816afdb53 100644 (file)
@@ -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