cpython-lru_cache-weakref: Doc/texinputs/python.sty comparison

comparison Doc/texinputs/python.sty @ 7764:9d0dc11775a4 legacy-trunk

Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.

author	Fred Drake <fdrake@acm.org>
date	Fri, 27 Mar 1998 05:22:53 +0000
parents	423be7cd0479
children	b17d200edf62

comparison

equal deleted inserted replaced

-:9c02e0a26511
+:9d0dc11775a4
 [1998/01/11 LaTeX package (Python markup)]
 % for PDF output, use maximal compression & a lot of other stuff
 % (test for PDF recommended by Tanmoy Bhattacharya <tanmoy@qcd.lanl.gov>)
 %
+\newif\if@doing@page@targets
+\@doing@page@targetsfalse
 \ifx\pdfoutput\undefined\else\ifcase\pdfoutput
 \let\LinkColor=\relax
 \let\NormalColor=\relax
 \else
 \input{pdfcolor}
 %
 \def\@begindvi{%
 \unvbox \@begindvibox
 \@hyperfixhead
 }
-\def\hyperpageanchor{\pdfdest name{page.\thepage}}
-\let\HYPERPAGEANCHOR\hyperpageanchor
 \def\@hyperfixhead{%
 \let\H@old@thehead\@thehead
-\gdef\@foo{\pdfdest name{page.\thepage} fit}%
+\gdef\@foo{\if@doing@page@targets\pdfdest name{page.\thepage} fit\fi}%
 \expandafter\ifx\expandafter\@empty\H@old@thehead
 \def\H@old@thehead{\hfil}\fi
 \def\@thehead{\@foo\relax\H@old@thehead}%
 }
 \fi\fi
 \OldEndVerbatim%
 \end{minipage}%
 \endgroup%
 }
-% Augment the sectioning commands used to get our own font family in place:
+\newcommand{\reset@python}{
-\renewcommand{\section}{\@startsection {section}{1}{\z@}%
+\global\let\@thisclass=\@undefined
+\global\let\@thismodule=\@undefined
+}
+\reset@python
+% Augment the sectioning commands used to get our own font family in place,
+% and reset some internal data items:
+\renewcommand{\section}{\reset@python%
+\@startsection {section}{1}{\z@}%
 {-3.5ex \@plus -1ex \@minus -.2ex}%
 {2.3ex \@plus.2ex}%
 {\reset@font\Large\HeaderFamily}}
 \renewcommand{\subsection}{\@startsection{subsection}{2}{\z@}%
 {-3.25ex\@plus -1ex \@minus -.2ex}%
 \cleardoublepage
 \OldTheindex
 \addcontentsline{toc}{chapter}{\indexname}
 }
-% these should dump an error or warning to the transcript
-\newcommand{\@thismodule}{$<<$ ERROR - NO CURRENT MODULE $>>$}
-\newcommand{\@thisclass}{$<<$ ERROR - NO CURRENT CLASS $>>$}
 \newcommand{\makemodindex}{
 \newwrite\modindexfile
 \openout\modindexfile=mod\jobname.idx
 \@UseModuleIndextrue
 }
 % Add the defining entry for a module
 \newcommand{\@modindex}[2]{%
-\renewcommand{\@thismodule}{#1}
+\global\def\@thismodule{#1}
-\setindexsubitem{(in module \@thismodule)}%
+\setindexsubitem{(in module #1)}%
 \index{#1@{\idxcode{#1}} (#2module)|textbf}%
 \if@UseModuleIndex%
 \write\modindexfile{\protect\indexentry{#1@{\tt #1}}{\thepage}}%
 \fi%
 }
 \rightmargin 0pt \topsep -\parskip \partopsep \parskip
 \itemsep -\parsep
 \let\makelabel=\itemnewline}
 }{\end{list}}
+% \optional is mostly for use in the arguments parameters to the various
-% cfuncdesc should be called as
+% {*desc} environments defined below, but may be used elsewhere.  Known to
-% \begin{cfuncdesc}{type}{name}{arglist}
+% be used in the debugger chapter.
-% ... description ...
-% \end{cfuncdesc}
-\newenvironment{cfuncdesc}[3]{%
-\begin{fulllineitems}%
-\item[\code{#1 \bfcode{#2}(\varvars{#3})}]%
-\index{#2@{\idxcode{#2()}}}%
-}{\end{fulllineitems}}
-\newenvironment{cvardesc}[2]{%
-\begin{fulllineitems}%
-\item[\code{#1 \bfcode{#2}}]%
-\index{#2@{\idxcode{#2}}}%
-}{\end{fulllineitems}}
-\newenvironment{ctypedesc}[1]{%
-\begin{fulllineitems}%
-\item[\bfcode{#1}]\ttindex{#1}
-}{\end{fulllineitems}}
-\newcommand{\funcline}[2]{\funclineni{#1}{#2}\ttindex{#1()}}
-\newenvironment{funcdesc}[2]{%
-\begin{fulllineitems}%
-\funcline{#1}{#2}%
-}{\end{fulllineitems}}
 \newcommand{\optional}[1]{%
 {\textnormal{\Large[}}{#1}\hspace{0.5mm}{\textnormal{\Large]}}}
+% C functions ------------------------------------------------------------
+% \begin{cfuncdesc}{type}{name}{arglist}
+\newenvironment{cfuncdesc}[3]{
+\begin{fulllineitems}
+\item[\code{#1 \bfcode{#2}(\varvars{#3})}\index{#2@{\idxcode{#2()}}}]
+}{\end{fulllineitems}}
+% C variables ------------------------------------------------------------
+% \begin{cvardesc}{type}{name}
+\newenvironment{cvardesc}[2]{
+\begin{fulllineitems}
+\item[\code{#1 \bfcode{#2}}\index{#2@{\idxcode{#2}}}]
+}{\end{fulllineitems}}
+% C data types -----------------------------------------------------------
+% \begin{ctypedesc}{typedef name}
+\newenvironment{ctypedesc}[1]{
+\begin{fulllineitems}
+\item[\bfcode{#1}\ttindex{#1}]
+}{\end{fulllineitems}}
+% simple functions (not methods) -----------------------------------------
+% \begin{funcdesc}{name}{args}
+\newcommand{\funcline}[2]{\funclineni{#1}{#2}\ttindex{#1()}}
+\newenvironment{funcdesc}[2]{
+\begin{fulllineitems}
+\funcline{#1}{#2}
+}{\end{fulllineitems}}
 % similar to {funcdesc}, but doesn't add to the index
 \newcommand{\funclineni}[2]{\item[\code{\bfcode{#1}(\varvars{#2})}]}
-\newenvironment{funcdescni}[2]{%
+\newenvironment{funcdescni}[2]{
-\begin{fulllineitems}%
+\begin{fulllineitems}
-\funclineni{#1}{#2}%
+\funclineni{#1}{#2}
 }{\end{fulllineitems}}
-\newenvironment{classdesc}[2]{%
+% classes ----------------------------------------------------------------
-\renewcommand{\@thisclass}{#1}%
+% \begin{classdesc}{name}{constructor args}
-\begin{fulllineitems}%
+\newenvironment{classdesc}[2]{
-\item[\code{\bfcode{#1}(\varvars{#2})}]%
+\global\def\@thisclass{#1}
-\withsubitem{(class in \@thismodule)}{\ttindex{#1}}%
+\begin{fulllineitems}
-\def\baseclasses##1{}%
+\item[\code{\bfcode{#1}(\varvars{#2})}%
-}{\end{fulllineitems}}
+\withsubitem{(class in \@thismodule)}{\ttindex{#1}}]
+\def\baseclasses##1{}
-\newenvironment{excdesc}[1]{%
+}{\end{fulllineitems}}
-\begin{fulllineitems}%
-\item[\bfcode{#1}]\ttindex{#1}%
-}{\end{fulllineitems}}
+\newcommand{\@classbadkey}{--bad current class--}
+\let\@classbadkey=\@undefined
+% object method ----------------------------------------------------------
+% \begin{methoddesc}[classname]{methodname}{args}
+\newcommand{\methodline}[3][\@classbadkey]{
+\methodlineni{#2}{#3}
+\ifx#1\@undefined
+\withsubitem{(\@thisclass\ method)}{\ttindex{#2()}}
+\else
+\withsubitem{(#1 method)}{\ttindex{#2()}}
+\fi
+}
+\newenvironment{methoddesc}[3][\@classbadkey]{
+\begin{fulllineitems}
+\ifx#1\@undefined
+\methodline{#2}{#3}
+\else
+\def\@thisclass{#1}
+\methodline[#1]{#2}{#3}
+\fi
+}{\end{fulllineitems}}
+% similar to {methoddesc}, but doesn't add to the index
+% (never actually uses the optional argument)
+\newcommand{\methodlineni}[3][\@classbadkey]{%
+\item[\code{\bfcode{#2}(\varvars{#3})}]}
+\newenvironment{methoddescni}[3][\@classbadkey]{
+\begin{fulllineitems}
+\methodlineni{#2}{#3}
+}{\end{fulllineitems}}
+% object data attribute --------------------------------------------------
+% \begin{memberdesc}[classname]{membername}
+\newcommand{\memberline}[2][\@classbadkey]{%
+\ifx#1\@undefined
+\memberlineni{#2}
+\withsubitem{(\@thisclass\ attribute)}{\ttindex{#2()}}
+\else
+\memberlineni{#2}
+\withsubitem{(#1 attribute)}{\ttindex{#2()}}
+\fi
+}
+\newenvironment{memberdesc}[2][\@classbadkey]{
+\begin{fulllineitems}
+\ifx#1\@undefined
+\memberline{#2}
+\else
+\def\@thisclass{#1}
+\memberline[#1]{#2}
+\fi
+}{\end{fulllineitems}}
+% similar to {memberdesc}, but doesn't add to the index
+% (never actually uses the optional argument)
+\newcommand{\memberlineni}[2][\@classbadkey]{\item[\bfcode{#2}]}
+\newenvironment{memberdescni}[2][\@classbadkey]{
+\begin{fulllineitems}
+\memberlineni{#2}
+}{\end{fulllineitems}}
+% For exceptions: --------------------------------------------------------
+% \begin{excdesc}{name}
+%  -- need support for constructor; maybe use optional parameter?
+\newenvironment{excdesc}[1]{
+\begin{fulllineitems}
+\item[\bfcode{#1}\ttindex{#1}]
+}{\end{fulllineitems}}
+% Module data or constants: ----------------------------------------------
+% \begin{datadesc}{name}
 \newcommand{\dataline}[1]{\datalineni{#1}\ttindex{#1}}
-\newenvironment{datadesc}[1]{%
+\newenvironment{datadesc}[1]{
-\begin{fulllineitems}%
+\begin{fulllineitems}
-\dataline{#1}%
+\dataline{#1}
 }{\end{fulllineitems}}
 % similar to {datadesc}, but doesn't add to the index
-\newcommand{\datalineni}[1]{\item[\bfcode{#1}]}
+\newcommand{\datalineni}[1]{\item[\bfcode{#1}]\nopagebreak}
-\newenvironment{datadescni}[1]{%
+\newenvironment{datadescni}[1]{
-\begin{fulllineitems}%
+\begin{fulllineitems}
-\datalineni{#1}%
+\datalineni{#1}
 }{\end{fulllineitems}}
-\newenvironment{opcodedesc}[2]{%
+% bytecode instruction ---------------------------------------------------
-\begin{fulllineitems}%
+% \begin{opcodedesc}{name}{var}
-\item[\bfcode{#1}\quad\var{#2}]%
+% -- {var} may be {}
+\newenvironment{opcodedesc}[2]{
+\begin{fulllineitems}
+\item[\bfcode{#1}\quad\var{#2}]
 }{\end{fulllineitems}}
 \let\nodename=\label
 % let's experiment with a new font:
 \newcommand{\file}[1]{`{\small\textsf{#1}}'}
 % Use this def/redef approach for \url{} since hyperref defined this already,
 % but only if we actually used hyperref:
-\@ifundefined{pdfannotlink}{%
+\@ifundefined{pdfannotlink}{
-\newcommand{\pythonurl}[1]{\mbox{\small\textsf{#1}}}%
+\newcommand{\pythonurl}[1]{\mbox{\small\textsf{#1}}}
 }{
 \newcommand{\pythonurl}[1]{{%
 \pdfannotlink attr{/Border [0 0 0]} user{/S /URI /URI (#1)}%
 \LinkColor%				color of the link text
-\mbox{\small\textsf{#1}}%
+{\small\textsf{#1}}%
 \NormalColor%			Turn it back off; these are declarative
 \pdfendlink}%			and don't appear bound to the current
 }%					formatting "box".
 }
 \let\url=\pythonurl
 %    % A funky case: module name contains '_'; have to supply an optional key
 %    \seemodule[copyreg]{copy_reg}{pickle interface constructor registration}
 %
 %  \end{seealso}
-\newif\if@keyedmodule\@keyedmodulefalse
 \newcommand{\@modulebadkey}{{--just-some-junk--}}
 \@ifundefined{pdfannotlink}{%
 \newcommand{\seemodule}[3][\@modulebadkey]{%
 \ifx\@modulebadkey#1\def\@modulekey{#2}\else\def\@modulekey{#1}\fi%

Mercurial > cpython-lru_cache-weakref

comparison Doc/texinputs/python.sty @ 7764:9d0dc11775a4 legacy-trunk