]> granicus.if.org Git - python/commitdiff
Clarify how the specify the name of a module with the 'module' directive.
authorBrett Cannon <bcannon@gmail.com>
Tue, 20 Jan 2009 02:09:18 +0000 (02:09 +0000)
committerBrett Cannon <bcannon@gmail.com>
Tue, 20 Jan 2009 02:09:18 +0000 (02:09 +0000)
Doc/documenting/markup.rst

index 05f9c4d8cb64376ab06c31d93cc99e21a9102154..82c75cfff00665a0ae8d626ea4237f4accc40e18 100644 (file)
@@ -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