Guido van Rossum | 6a11eb4 | 1992-06-03 17:59:07 +0000 | [diff] [blame] | 1 | % Template for library sections. |
| 2 | % Replace text in ALL CAPS by your own text. |
| 3 | % Comments starting with %** give additional directions. |
| 4 | |
| 5 | %** Choose one of the following two section headings: |
| 6 | \section{Built-in module {\tt YOUR-MODULE-NAME}} % If written in C |
| 7 | \section{Standard module {\tt YOUR-MODULE-NAME}} % If written in Python |
| 8 | |
| 9 | PUT A SHORT INTRODUCTION AND DESCRIPTION OF THE MODULE HERE. |
| 10 | |
| 11 | %** change this sentence to taste: |
| 12 | The module defines the following variables and functions: |
| 13 | |
| 14 | \begin{description} |
| 15 | |
| 16 | \renewcommand{\indexsubitem}{(in module YOUR-MODULE-NAME)} |
| 17 | |
| 18 | |
| 19 | %** You can mix exceptions, variables and functions below; often it is a |
| 20 | %** good idea to alphabetize them all. |
| 21 | |
| 22 | |
| 23 | %** repeat the following for each exception: |
| 24 | \excitem{NAME} |
| 25 | DESCRIPTION OF THE EXCEPTION GOES HERE. |
| 26 | |
| 27 | |
| 28 | %** repeat the following for each variable (or constant): |
| 29 | \dataitem{NAME} |
| 30 | DESCRIPTION OF THE VARIABLE/CONSTANT GOES HERE. |
| 31 | |
| 32 | |
| 33 | %** repeat the following for each function: |
| 34 | \funcitem{NAME}{PARAMETERS} % Don't include the parentheses |
| 35 | DESCRIPTION OF THE FUNCTION GOES HERE. |
| 36 | |
| 37 | |
| 38 | \end{description} |
| 39 | |
| 40 | ADDITIONAL HINTS FOR USING THE MODULE MAY GO HERE. |