]> granicus.if.org Git - python/commitdiff
Clarify wording.
authorGeorg Brandl <georg@python.org>
Thu, 22 Jan 2009 18:29:28 +0000 (18:29 +0000)
committerGeorg Brandl <georg@python.org>
Thu, 22 Jan 2009 18:29:28 +0000 (18:29 +0000)
Doc/documenting/markup.rst

index 80b43b9850329d375c2f20af2392155e2a3a76c5..b4b03d27a53538cf3c3e439910733e70e75677ee 100644 (file)
@@ -285,7 +285,8 @@ Inline markup
 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 @@ a matching identifier is found:
 
 .. describe:: data
 
-   The name of a module-level variable.
+   The name of a module-level variable or constant.
 
 .. describe:: const