diff options
| author | Georg Brandl <georg@python.org> | 2007-08-31 06:59:27 (GMT) |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2007-08-31 06:59:27 (GMT) |
| commit | 9856e05d56c0337bdf62a7c8aecf2551fd7275ca (patch) | |
| tree | f8b01f1542cac23ea7c3084053333f848fa1f3cc /Doc/documenting | |
| parent | 628e3bb808db629a095646d0b174989a008013f3 (diff) | |
| download | cpython-9856e05d56c0337bdf62a7c8aecf2551fd7275ca.zip cpython-9856e05d56c0337bdf62a7c8aecf2551fd7275ca.tar.gz cpython-9856e05d56c0337bdf62a7c8aecf2551fd7275ca.tar.bz2 | |
Document new shorthand notation for index entries.
Diffstat (limited to 'Doc/documenting')
| -rw-r--r-- | Doc/documenting/markup.rst | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst index 1bb2185..8d0cc3e 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 |