diff options
author | Fred Drake <fdrake@acm.org> | 1997-12-15 21:20:03 (GMT) |
---|---|---|
committer | Fred Drake <fdrake@acm.org> | 1997-12-15 21:20:03 (GMT) |
commit | d9dbfbd33ceaa2b92f394e582487c89260d24af2 (patch) | |
tree | 3f9eb13fe2e15179fc14ac84f6eab4d4bf4ddaba /Doc/templates/module.tex | |
parent | 80fb344a188fd201144a47a0d41a62fb97ff01ec (diff) | |
download | cpython-d9dbfbd33ceaa2b92f394e582487c89260d24af2.zip cpython-d9dbfbd33ceaa2b92f394e582487c89260d24af2.tar.gz cpython-d9dbfbd33ceaa2b92f394e582487c89260d24af2.tar.bz2 |
At the top, made it clear that the \bimodindex{} and \stmodindex{} are only
used for the defining entry for the module, not every index reference.
Diffstat (limited to 'Doc/templates/module.tex')
-rw-r--r-- | Doc/templates/module.tex | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/Doc/templates/module.tex b/Doc/templates/module.tex index a4fae28..2e56c47 100644 --- a/Doc/templates/module.tex +++ b/Doc/templates/module.tex @@ -5,7 +5,10 @@ % ==== 1. ==== % Choose one of the following section headers and index entries; % \section{} generates the section header, -% \bimodindex{} or \stmodundex{} generates an index entry for this module. +% \bimodindex{} or \stmodindex{} generates an index entry for this +% module. Note that these should only be used for the defining entry +% for the module. Other references to the module should use +% \refbimodindex{} or \refstmodindex{}. % The \label{module-spam} line is for the \seealso{} command. \section{Built-in Module \sectcode{spam}} % If implemented in C |