From: Georg Brandl Date: Thu, 22 Jan 2009 18:29:28 +0000 (+0000) Subject: Clarify wording. X-Git-Tag: v2.7a1~2222 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=40e841550930e3729597b649814940d4cbeabf18;p=python Clarify wording. --- diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst index 80b43b9850..b4b03d27a5 100644 --- a/Doc/documenting/markup.rst +++ b/Doc/documenting/markup.rst @@ -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