summaryrefslogtreecommitdiffstats
path: root/Doc/templates/module.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2001-06-06 16:02:47 (GMT)
committerFred Drake <fdrake@acm.org>2001-06-06 16:02:47 (GMT)
commit2a9bda92234fa9084220c4ecb591544a41aae823 (patch)
tree2e28ce3805d662f66e11fbbade1384286e9fb516 /Doc/templates/module.tex
parent9ccc0df52f40f12451050487518cb0fb0184a2ce (diff)
downloadcpython-2a9bda92234fa9084220c4ecb591544a41aae823.zip
cpython-2a9bda92234fa9084220c4ecb591544a41aae823.tar.gz
cpython-2a9bda92234fa9084220c4ecb591544a41aae823.tar.bz2
Typo: "descrition" --> "description"
Add reference to the documentation for the Python documentation markup. Fixed up a couple of descriptions. This closes SF bug #430627.
Diffstat (limited to 'Doc/templates/module.tex')
-rw-r--r--Doc/templates/module.tex13
1 files changed, 10 insertions, 3 deletions
diff --git a/Doc/templates/module.tex b/Doc/templates/module.tex
index 33d769d..1a0117d 100644
--- a/Doc/templates/module.tex
+++ b/Doc/templates/module.tex
@@ -1,5 +1,12 @@
% Template for a library manual section.
% PLEASE REMOVE THE COMMENTS AFTER USING THE TEMPLATE
+%
+% Complete documentation on the extended LaTeX markup used for Python
+% documentation is available in ``Documenting Python'', which is part
+% of the standard documentation for Python. It may be found online
+% at:
+%
+% http://www.python.org/doc/current/doc/doc.html
% ==== 0. ====
% Copy this file to <mydir>/lib<mymodule>.tex, and edit that file
@@ -13,7 +20,7 @@
% appropriate.
\section{\module{spam} ---
- Short descrition, for section title}
+ Short description, for section title and table of contents}
% Choose one of these to specify the module module name. If there's
% an underscore in the name, use
@@ -31,9 +38,9 @@
% Please use a name that has already been used whenever applicable. If this
% is omitted, no availability statement is produced or implied.
%
-% \platform{UNIX}
+% \platform{Unix}
-% These apply to all modules:
+% These apply to all modules, and may be given more than once:
\moduleauthor{name}{email} % Author of the module code;
% omit if not known.