summaryrefslogtreecommitdiffstats
path: root/Doc/templates/module.tex
diff options
context:
space:
mode:
authorGuido van Rossum <guido@python.org>1992-06-03 17:59:07 (GMT)
committerGuido van Rossum <guido@python.org>1992-06-03 17:59:07 (GMT)
commit6a11eb4e1710259f89f2edb0d0edc4ccf208e170 (patch)
treefb000a71567383a95f433f27cdddcf87ed8208e4 /Doc/templates/module.tex
parent54e39908d848f4e3d1d09685798329ea73013262 (diff)
downloadcpython-6a11eb4e1710259f89f2edb0d0edc4ccf208e170.zip
cpython-6a11eb4e1710259f89f2edb0d0edc4ccf208e170.tar.gz
cpython-6a11eb4e1710259f89f2edb0d0edc4ccf208e170.tar.bz2
Initial revision
Diffstat (limited to 'Doc/templates/module.tex')
-rw-r--r--Doc/templates/module.tex40
1 files changed, 40 insertions, 0 deletions
diff --git a/Doc/templates/module.tex b/Doc/templates/module.tex
new file mode 100644
index 0000000..7465af8
--- /dev/null
+++ b/Doc/templates/module.tex
@@ -0,0 +1,40 @@
+% Template for library sections.
+% Replace text in ALL CAPS by your own text.
+% Comments starting with %** give additional directions.
+
+%** Choose one of the following two section headings:
+\section{Built-in module {\tt YOUR-MODULE-NAME}} % If written in C
+\section{Standard module {\tt YOUR-MODULE-NAME}} % If written in Python
+
+PUT A SHORT INTRODUCTION AND DESCRIPTION OF THE MODULE HERE.
+
+%** change this sentence to taste:
+The module defines the following variables and functions:
+
+\begin{description}
+
+\renewcommand{\indexsubitem}{(in module YOUR-MODULE-NAME)}
+
+
+%** You can mix exceptions, variables and functions below; often it is a
+%** good idea to alphabetize them all.
+
+
+%** repeat the following for each exception:
+\excitem{NAME}
+DESCRIPTION OF THE EXCEPTION GOES HERE.
+
+
+%** repeat the following for each variable (or constant):
+\dataitem{NAME}
+DESCRIPTION OF THE VARIABLE/CONSTANT GOES HERE.
+
+
+%** repeat the following for each function:
+\funcitem{NAME}{PARAMETERS} % Don't include the parentheses
+DESCRIPTION OF THE FUNCTION GOES HERE.
+
+
+\end{description}
+
+ADDITIONAL HINTS FOR USING THE MODULE MAY GO HERE.