mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-01 18:51:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 21

Clarify how the specify the name of a module with the 'module' directive.

Browse source
This commit is contained in:
Brett Cannon 2009-01-20 02:09:18 +00:00
parent 7edf1298c4
commit df50106408
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
Doc/documenting/markup.rst
View 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