summaryrefslogtreecommitdiffstats
path: root/Doc/doc/doc.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2000-09-11 05:22:30 (GMT)
committerFred Drake <fdrake@acm.org>2000-09-11 05:22:30 (GMT)
commit08c5d0cdcbf079feb47b66df626dd926f13b9845 (patch)
treed3a8ba2e692298a0477ec6cf920fbf5c01b1811e /Doc/doc/doc.tex
parent526a18235aa4fc0ce1234d1a645d00304986744a (diff)
downloadcpython-08c5d0cdcbf079feb47b66df626dd926f13b9845.zip
cpython-08c5d0cdcbf079feb47b66df626dd926f13b9845.tar.gz
cpython-08c5d0cdcbf079feb47b66df626dd926f13b9845.tar.bz2
Add documentation for the \pep and \seepep macros.
Diffstat (limited to 'Doc/doc/doc.tex')
-rw-r--r--Doc/doc/doc.tex27
1 files changed, 21 insertions, 6 deletions
diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index 334dfdb..a834ab3 100644
--- a/Doc/doc/doc.tex
+++ b/Doc/doc/doc.tex
@@ -534,6 +534,13 @@ distribution, to create or maintain whole documents or sections.
\var{option}.
\end{macrodesc}
+ \begin{macrodesc}{pep}{\p{number}}
+ A reference to a Python Enhancement Proposal. This generates
+ appropriate index entries. The text \samp{PEP \var{number}} is
+ generated; in the HTML output, this text is a hyperlink to an
+ online copy of the specified PEP.
+ \end{macrodesc}
+
\begin{macrodesc}{refmodule}{\op{key}\p{name}}
Like \macro{module}, but create a hyperlink to the documentation
for the named module. Note that the corresponding
@@ -811,13 +818,21 @@ distribution, to create or maintain whole documents or sections.
document (the corresponding \macro{declaremodule} is required).
\end{macrodesc}
- \begin{macrodesc}{seerfc}{\p{number}\p{title}\p{why}}
- Refer to an IETF Request for Comments (RFC). \var{number}
- should be the official number assigned by the RFC Editor,
- \var{title} should be the human-readable title of the RFC as
+ \begin{macrodesc}{seepep}{\p{number}\p{title}\p{why}}
+ Refer to an Python Enhancement Proposal (PEP). \var{number}
+ should be the official number assigned by the PEP Editor,
+ \var{title} should be the human-readable title of the PEP as
found in the official copy of the document, and \var{why} should
- explain what's interesting about the RFC. This should be used
- to refer the reader to RFCs which specify protocols or data
+ explain what's interesting about the PEP. This should be used
+ to refer the reader to PEPs which specify interfaces or language
+ features relevant to the material in the annotated section of the
+ documentation.
+ \end{macrodesc}
+
+ \begin{macrodesc}{seerfc}{\p{number}\p{title}\p{why}}
+ Refer to an IETF Request for Comments (RFC). Otherwise very
+ similar to \macro{seepep}. This should be used
+ to refer the reader to PEPs which specify protocols or data
formats relevant to the material in the annotated section of the
documentation.
\end{macrodesc}