From 4e607964d1fa55a49dad145c3bc5baf56fa8a179 Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Sat, 9 Sep 2000 06:01:25 +0000 Subject: excclassdesc: New environment. For use in documenting class-based exceptions which have interesting constructor signatures. \pep, \seepep: New macros. Equivalent to \rfc and \seerfc, but referring to the PEP series instead of the Internet RFC series of documents. --- Doc/texinputs/python.sty | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/Doc/texinputs/python.sty b/Doc/texinputs/python.sty index 9d0db97..40c870b 100644 --- a/Doc/texinputs/python.sty +++ b/Doc/texinputs/python.sty @@ -601,6 +601,16 @@ \withsubitem{(class in \py@thismodule)}{\ttindex{#1}}] }{\end{fulllineitems}} +% \begin{excclassdesc}{name}{constructor args} +% but indexes as an exception +\newenvironment{excclassdesc}[2]{ + % Using \renewcommand doesn't work for this, for unknown reasons: + \global\def\py@thisclass{#1} + \begin{fulllineitems} + \item[\code{\bfcode{#1}(\py@varvars{#2})}% + \withsubitem{(exception in \py@thismodule)}{\ttindex{#1}}] +}{\end{fulllineitems}} + \let\py@classbadkey=\@undefined @@ -803,6 +813,7 @@ \newcommand{\constant}[1]{\code{#1}} % manifest constant, not syntactic \newcommand{\manpage}[2]{{\emph{#1}(#2)}} +\newcommand{\pep}[1]{PEP #1\index{Python Enhancement Proposals!PEP #1}} \newcommand{\rfc}[1]{RFC #1\index{RFC!RFC #1}} \newcommand{\program}[1]{\strong{#1}} \newcommand{\programopt}[1]{\strong{#1}} @@ -911,6 +922,14 @@ \end{fulllineitems} } } +% \seepep{number}{title}{why it's interesting} +\newcommand{\py@seepep}[3]{% + \par% + \begin{fulllineitems} + \item[\pep{#1}, ``\emph{#2}''] + #3 + \end{fulllineitems} +} % \seerfc{number}{title}{why it's interesting} \newcommand{\py@seerfc}[3]{% \par% -- cgit v0.12