]> granicus.if.org Git - python/commitdiff
At the top, made it clear that the \bimodindex{} and \stmodindex{} are only
authorFred Drake <fdrake@acm.org>
Mon, 15 Dec 1997 21:20:03 +0000 (21:20 +0000)
committerFred Drake <fdrake@acm.org>
Mon, 15 Dec 1997 21:20:03 +0000 (21:20 +0000)
used for the defining entry for the module, not every index reference.

Doc/lib/libtemplate.tex
Doc/libtemplate.tex
Doc/templates/module.tex

index a4fae281793995ba0d8e41c5c4c230e4c979886f..2e56c4710febba5174d444a9b978b2a3fc12e2a0 100644 (file)
@@ -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
index a4fae281793995ba0d8e41c5c4c230e4c979886f..2e56c4710febba5174d444a9b978b2a3fc12e2a0 100644 (file)
@@ -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
index a4fae281793995ba0d8e41c5c4c230e4c979886f..2e56c4710febba5174d444a9b978b2a3fc12e2a0 100644 (file)
@@ -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