mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-29 14:15:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Fix subitem markup.

Browse source
This commit is contained in:
Georg Brandl 2007-08-31 08:47:51 +00:00
parent 9856e05d56
commit 3acd6d5f58
1 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

14
Doc/documenting/markup.rst
View file

@ -707,7 +707,7 @@ consists of a type and a value, separated by a colon.
For example::
.. index::
single: execution!context
single: execution; context
module: __main__
module: sys
triple: module; search; path
@ -720,18 +720,18 @@ The possible entry types are:
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::