From: Georg Brandl <georg@python.org>
Date: Fri, 31 Aug 2007 08:47:51 +0000 (+0000)
Subject: Fix subitem markup.
X-Git-Tag: v2.6a1~1370
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=3acd6d5f58e0a27f8ecaecd720b0deb813e690f8;p=python

Fix subitem markup.
---

diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst
index 8d0cc3e701..f85158b163 100644
--- a/Doc/documenting/markup.rst
+++ b/Doc/documenting/markup.rst
@@ -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::