From 40e841550930e3729597b649814940d4cbeabf18 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Thu, 22 Jan 2009 18:29:28 +0000 Subject: [PATCH] Clarify wording. --- Doc/documenting/markup.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst index 80b43b98503..b4b03d27a53 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