From: Georg Brandl <georg@python.org>
Date: Fri, 31 Aug 2007 06:59:27 +0000 (+0000)
Subject: Document new shorthand notation for index entries.
X-Git-Tag: v2.6a1~1371
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=9856e05d56c0337bdf62a7c8aecf2551fd7275ca;p=python

Document new shorthand notation for index entries.
---

diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst
index 1bb2185736..8d0cc3e701 100644
--- a/Doc/documenting/markup.rst
+++ b/Doc/documenting/markup.rst
@@ -724,14 +724,21 @@ single
    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::
+
+   .. index:: BNF, grammar, syntax, notation
+
+This creates four index entries.
 
 
 Grammar production displays