diff options
| author | Brett Cannon <bcannon@gmail.com> | 2009-01-20 02:09:18 (GMT) |
|---|---|---|
| committer | Brett Cannon <bcannon@gmail.com> | 2009-01-20 02:09:18 (GMT) |
| commit | df50106408d525a8e7022b6545ecbd0c13ce8740 (patch) | |
| tree | 76764b70088f238aced831100e6c65ef5e37d9f4 /Doc/documenting | |
| parent | 7edf1298c46642adbec42e0b539fa058528166fd (diff) | |
| download | cpython-df50106408d525a8e7022b6545ecbd0c13ce8740.zip cpython-df50106408d525a8e7022b6545ecbd0c13ce8740.tar.gz cpython-df50106408d525a8e7022b6545ecbd0c13ce8740.tar.bz2 | |
Clarify how the specify the name of a module with the 'module' directive.
Diffstat (limited to 'Doc/documenting')
| -rw-r--r-- | Doc/documenting/markup.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst index 05f9c4d..82c75cf 100644 --- a/Doc/documenting/markup.rst +++ b/Doc/documenting/markup.rst @@ -53,9 +53,9 @@ As you can see, the module-specific markup consists of two directives, the .. describe:: module - This directive marks the beginning of the description of a module (or package - submodule, in which case the name should be fully qualified, including the - package name). + This directive marks the beginning of the description of a module, package, + or submodule. The name should be fully qualified (i.e. including the + package name for submodules). The ``platform`` option, if present, is a comma-separated list of the platforms on which the module is available (if it is available on all |