[Python-checkins] r68790 - python/branches/py3k/Doc/documenting/markup.rst
brett.cannon
python-checkins at python.org
Tue Jan 20 03:09:18 CET 2009
Author: brett.cannon
Date: Tue Jan 20 03:09:18 2009
New Revision: 68790
Log:
Clarify how the specify the name of a module with the 'module' directive.
Modified:
python/branches/py3k/Doc/documenting/markup.rst
Modified: python/branches/py3k/Doc/documenting/markup.rst
==============================================================================
--- python/branches/py3k/Doc/documenting/markup.rst (original)
+++ python/branches/py3k/Doc/documenting/markup.rst Tue Jan 20 03:09:18 2009
@@ -53,9 +53,9 @@
.. 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
More information about the Python-checkins
mailing list