Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit df50106

Browse files
committed
Clarify how the specify the name of a module with the 'module' directive.
1 parent 7edf129 commit df50106

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

Doc/documenting/markup.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ As you can see, the module-specific markup consists of two directives, the
5353

5454
.. describe:: module
5555

56-
This directive marks the beginning of the description of a module (or package
57-
submodule, in which case the name should be fully qualified, including the
58-
package name).
56+
This directive marks the beginning of the description of a module, package,
57+
or submodule. The name should be fully qualified (i.e. including the
58+
package name for submodules).
5959

6060
The ``platform`` option, if present, is a comma-separated list of the
6161
platforms on which the module is available (if it is available on all

0 commit comments

Comments
 (0)