diff options
Diffstat (limited to 'Doc/ref/ref6.tex')
| -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 |