update; text from Edward Loper

This commit is contained in:
David Goodger 2004-04-23 13:29:34 +00:00
parent d8f2eaf03c
commit ef1e37dcf3
1 changed files with 5 additions and 0 deletions

View File

@ -840,6 +840,11 @@ variable, ``__docformat__``, may appear at the top level of a module
before any function or class definitions. Over time or through
decree, a standard format or set of formats should emerge.
A module's ``__docformat__`` variable only applies to the objects
defined in the module's file. In particular, the ``__docformat__``
variable in a package's ``__init__.py`` file does not apply to objects
defined in subpackages and submodules.
The ``__docformat__`` variable is a string containing the name of the
format being used, a case-insensitive string matching the input
parser's module or package name (i.e., the same name as required to