traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Document new shorthand notation for index entries.

This commit is contained in:
Georg Brandl 2007-08-31 06:59:27 +00:00
parent 628e3bb808
commit 9856e05d56
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Doc/documenting/markup.rst
View File

@ -724,14 +724,21 @@ single
entries are created). entries are created).
pair pair
``pair: loop; statement`` is a shortcut that creates two index entries, ``pair: loop; statement`` is a shortcut that creates two index entries,
namely ``loop; statement`` and ``statement; loop``. namely ``loop!statement`` and ``statement!loop``.
triple triple
Likewise, ``triple: module; search; path`` is a shortcut that creates three Likewise, ``triple: module; search; path`` is a shortcut that creates three
index entries, which are ``module; search path``, ``search; path, module`` and index entries, which are ``module!search path``, ``search!path, module`` and
``path; module search``. ``path!module search``.
module, keyword, operator, object, exception, statement, builtin module, keyword, operator, object, exception, statement, builtin
These all create two index entries. For example, ``module: hashlib`` creates 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::
.. index:: BNF, grammar, syntax, notation
This creates four index entries.
Grammar production displays Grammar production displays