Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Clarify wording.

This commit is contained in:
Georg Brandl 2009-01-22 18:29:28 +00:00
parent 1bc1c8ac76
commit 40e8415509
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Doc/documenting/markup.rst
View 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