diff options
| author | Benjamin Peterson <benjamin@python.org> | 2009-01-23 03:26:36 (GMT) |
|---|---|---|
| committer | Benjamin Peterson <benjamin@python.org> | 2009-01-23 03:26:36 (GMT) |
| commit | aa069003471ab31c896cec807d7121c6a457aa0e (patch) | |
| tree | 717a52bb9f7fbc44b8e0a923f6daf818d19c8313 /Doc/documenting | |
| parent | 83b97306ae902d68baaf55b10d0be2a78150f41f (diff) | |
| download | cpython-aa069003471ab31c896cec807d7121c6a457aa0e.zip cpython-aa069003471ab31c896cec807d7121c6a457aa0e.tar.gz cpython-aa069003471ab31c896cec807d7121c6a457aa0e.tar.bz2 | |
Merged revisions 68750,68776-68777,68811,68842,68859 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r68750 | benjamin.peterson | 2009-01-18 16:47:04 -0600 (Sun, 18 Jan 2009) | 1 line
fix encoding cookie case
........
r68776 | benjamin.peterson | 2009-01-19 10:17:54 -0600 (Mon, 19 Jan 2009) | 1 line
move BufferedIOBase into the base class section
........
r68777 | benjamin.peterson | 2009-01-19 10:18:27 -0600 (Mon, 19 Jan 2009) | 1 line
add email address
........
r68811 | benjamin.peterson | 2009-01-20 12:58:27 -0600 (Tue, 20 Jan 2009) | 1 line
fix url
........
r68842 | andrew.kuchling | 2009-01-20 20:16:26 -0600 (Tue, 20 Jan 2009) | 1 line
Markup fixes
........
r68859 | georg.brandl | 2009-01-22 12:29:28 -0600 (Thu, 22 Jan 2009) | 2 lines
Clarify wording.
........
Diffstat (limited to 'Doc/documenting')
| -rw-r--r-- | Doc/documenting/markup.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst index 82c75cf..a919468 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 |