diff options
| author | Raymond Hettinger <python@rcn.com> | 2003-01-06 12:54:54 (GMT) |
|---|---|---|
| committer | Raymond Hettinger <python@rcn.com> | 2003-01-06 12:54:54 (GMT) |
| commit | 1772f176668dac4f1ad6aa425ecbc71a1fbcae73 (patch) | |
| tree | a4ed770957601d0d9538f341accabde655ed0f7c | |
| parent | fb8595df4f9583ab9e83826cd782e0c18ba9cffa (diff) | |
| download | cpython-1772f176668dac4f1ad6aa425ecbc71a1fbcae73.zip cpython-1772f176668dac4f1ad6aa425ecbc71a1fbcae73.tar.gz cpython-1772f176668dac4f1ad6aa425ecbc71a1fbcae73.tar.bz2 | |
SF bug #661848 and #631055: Clarify use of __all__.
| -rw-r--r-- | Doc/ref/ref6.tex | 5 |
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 |