Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit d9dbfbd

Browse files
committed
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.
1 parent 80fb344 commit d9dbfbd

3 files changed

Lines changed: 12 additions & 3 deletions

File tree

Doc/lib/libtemplate.tex

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@
55
% ==== 1. ====
66
% Choose one of the following section headers and index entries;
77
% \section{} generates the section header,
8-
% \bimodindex{} or \stmodundex{} generates an index entry for this module.
8+
% \bimodindex{} or \stmodindex{} generates an index entry for this
9+
% module. Note that these should only be used for the defining entry
10+
% for the module. Other references to the module should use
11+
% \refbimodindex{} or \refstmodindex{}.
912
% The \label{module-spam} line is for the \seealso{} command.
1013

1114
\section{Built-in Module \sectcode{spam}} % If implemented in C

Doc/libtemplate.tex

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@
55
% ==== 1. ====
66
% Choose one of the following section headers and index entries;
77
% \section{} generates the section header,
8-
% \bimodindex{} or \stmodundex{} generates an index entry for this module.
8+
% \bimodindex{} or \stmodindex{} generates an index entry for this
9+
% module. Note that these should only be used for the defining entry
10+
% for the module. Other references to the module should use
11+
% \refbimodindex{} or \refstmodindex{}.
912
% The \label{module-spam} line is for the \seealso{} command.
1013

1114
\section{Built-in Module \sectcode{spam}} % If implemented in C

Doc/templates/module.tex

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@
55
% ==== 1. ====
66
% Choose one of the following section headers and index entries;
77
% \section{} generates the section header,
8-
% \bimodindex{} or \stmodundex{} generates an index entry for this module.
8+
% \bimodindex{} or \stmodindex{} generates an index entry for this
9+
% module. Note that these should only be used for the defining entry
10+
% for the module. Other references to the module should use
11+
% \refbimodindex{} or \refstmodindex{}.
912
% The \label{module-spam} line is for the \seealso{} command.
1013

1114
\section{Built-in Module \sectcode{spam}} % If implemented in C

0 commit comments

Comments
 (0)