SF bug #661848 and #631055: Clarify use of __all__.

This commit is contained in:
Raymond Hettinger 2003-01-06 12:54:54 +00:00
parent fb8595df4f
commit 1772f17666
1 changed files with 4 additions and 1 deletions

View 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