blob: 7465af8720b9da066c1a5221805032272cfcaaac (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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.
|
