[Python-checkins] r68859 - python/trunk/Doc/documenting/markup.rst

[georg.brandl]

Author: georg.brandl
Date: Thu Jan 22 19:29:28 2009
New Revision: 68859

Log:
Clarify wording.


Modified:
   python/trunk/Doc/documenting/markup.rst

Modified: python/trunk/Doc/documenting/markup.rst
==============================================================================
--- python/trunk/Doc/documenting/markup.rst	(original)
+++ python/trunk/Doc/documenting/markup.rst	Thu Jan 22 19:29:28 2009
@@ -285,7 +285,8 @@
 As said before, Sphinx uses interpreted text roles to insert semantic markup in
 documents.
 
-Variable names are an exception, they should be marked simply with ``*var*``.
+Names of local variables, such as function/method arguments, are an exception,
+they should be marked simply with ``*var*``.
 
 For all other roles, you have to write ``:rolename:`content```.
 
@@ -310,7 +311,7 @@
 
 .. describe:: data
 
-   The name of a module-level variable.
+   The name of a module-level variable or constant.
 
 .. describe:: const