From df50106408d525a8e7022b6545ecbd0c13ce8740 Mon Sep 17 00:00:00 2001 From: Brett Cannon Date: Tue, 20 Jan 2009 02:09:18 +0000 Subject: Clarify how the specify the name of a module with the 'module' directive. --- Doc/documenting/markup.rst | 6 +++--- 1 file 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 -- cgit v0.12