diff options
author | Fred Drake <fdrake@acm.org> | 1998-07-23 17:59:49 (GMT) |
---|---|---|
committer | Fred Drake <fdrake@acm.org> | 1998-07-23 17:59:49 (GMT) |
commit | b91e934cf1c45353a06eef77eac7cec609406646 (patch) | |
tree | 2eac55d1be7c062adef06708851208d20c896415 /Doc/templates/module.tex | |
parent | fe7f3bc2aa5c59699aa87f6fbe6831f3742039a1 (diff) | |
download | cpython-b91e934cf1c45353a06eef77eac7cec609406646.zip cpython-b91e934cf1c45353a06eef77eac7cec609406646.tar.gz cpython-b91e934cf1c45353a06eef77eac7cec609406646.tar.bz2 |
Adjusted to use the new module synopsis support macros.
Diffstat (limited to 'Doc/templates/module.tex')
-rw-r--r-- | Doc/templates/module.tex | 26 |
1 files changed, 12 insertions, 14 deletions
diff --git a/Doc/templates/module.tex b/Doc/templates/module.tex index d190506..e82bb21 100644 --- a/Doc/templates/module.tex +++ b/Doc/templates/module.tex @@ -4,29 +4,27 @@ % ==== 1. ==== % Choose one of the following section headers and index entries; -% \section generates the section header, -% \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, \refstmodindex, \refexmodindex or \refmodindex, as -% appropriate. (Just prepend "ref" to the csname of the \*modindex -% macro used in the module definition.) -% -% The \label{module-spam} line is for the \seealso command. +% \section generates the section header, \declmodule produces the +% appropriate 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, \refstmodindex, +% \refexmodindex or \refmodindex, as appropriate. \section{Built-in Module \module{spam}} % If implemented in C, in -\bimodindex{spam} % standard library +\declaremodule{builtin}{spam} % standard library \section{Standard Module \module{spam}} % If implemented in Python, in -\stmodindex{spam} % standard library +\declaremodule{standard}{spam} % standard library \section{Extension Module \module{spam}}% If implemented in C, but not -\exmodindex{spam} % in standard library +\declaremodule{extension}{spam} % in standard library \section{Module \module{spam}} % If implemented in Python, but not -\modindex{spam} % in standard library +\declaremodule{}{spam} % in standard library + + +\modulesynopsis{This is a one-line descrition, for the chapter header.} -\label{module-spam} % ==== 2. ==== % Give a short overview of what the module does. |