[Python-checkins] r57827 - python/trunk/Doc/documenting/markup.rst
georg.brandl
python-checkins at python.org
Fri Aug 31 10:47:51 CEST 2007
Author: georg.brandl
Date: Fri Aug 31 10:47:51 2007
New Revision: 57827
Modified:
python/trunk/Doc/documenting/markup.rst
Log:
Fix subitem markup.
Modified: python/trunk/Doc/documenting/markup.rst
==============================================================================
--- python/trunk/Doc/documenting/markup.rst (original)
+++ python/trunk/Doc/documenting/markup.rst Fri Aug 31 10:47:51 2007
@@ -707,7 +707,7 @@
For example::
.. index::
- single: execution!context
+ single: execution; context
module: __main__
module: sys
triple: module; search; path
@@ -720,18 +720,18 @@
single
Creates a single index entry. Can be made a subentry by separating the
- subentry text with a semicolon (this is also used below to describe what
- entries are created).
+ subentry text with a semicolon (this notation is also used below to describe
+ what entries are created).
pair
``pair: loop; statement`` is a shortcut that creates two index entries,
- namely ``loop!statement`` and ``statement!loop``.
+ namely ``loop; statement`` and ``statement; loop``.
triple
Likewise, ``triple: module; search; path`` is a shortcut that creates three
- index entries, which are ``module!search path``, ``search!path, module`` and
- ``path!module search``.
+ index entries, which are ``module; search path``, ``search; path, module`` and
+ ``path; module search``.
module, keyword, operator, object, exception, statement, builtin
These all create two index entries. For example, ``module: hashlib`` creates
- the entries ``module!hashlib`` and ``hashlib!module``.
+ the entries ``module; hashlib`` and ``hashlib; module``.
For index directives containing only "single" entries, there is a shorthand
notation::
More information about the Python-checkins
mailing list