Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-30 21:21:22 +00:00
Code Issues Projects Releases Packages Wiki Activity

Label classes and exceptions explicitly in the documentation (for their

Browse source 
*desc environments).
This commit is contained in:
Fred Drake 2001-03-02 18:57:05 +00:00
parent 0539bfaaa4
commit ab357ecf7f
2 changed files with 19 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

6
Doc/perl/python.perl
View file

@ -882,7 +882,7 @@ sub do_env_excdesc{
local($_) = @_; local($_) = @_;
my $excname = next_argument(); my $excname = next_argument();
my $idx = make_str_index_entry("<tt class='exception'>$excname</tt>"); my $idx = make_str_index_entry("<tt class='exception'>$excname</tt>");
return "<dl><dt><b>$idx</b>\n<dd>" . $_ . '</dl>' return "<dl><dt><b>exception $idx</b>\n<dd>" . $_ . '</dl>'
} }
sub do_env_fulllineitems{ return do_env_itemize(@_); } sub do_env_fulllineitems{ return do_env_itemize(@_); }
@ -895,7 +895,9 @@ sub handle_classlike_descriptor{
$idx = make_str_index_entry( $idx = make_str_index_entry(
"<tt class='$what'>$THIS_CLASS</tt> ($what in $THIS_MODULE)" ); "<tt class='$what'>$THIS_CLASS</tt> ($what in $THIS_MODULE)" );
$idx =~ s/ \(.*\)//; $idx =~ s/ \(.*\)//;
return "<dl><dt><b>$idx</b> (<var>$arg_list</var>)\n<dd>" . $_ . '</dl>'; return ("<dl><dt><b>$what $idx</b> (<var>$arg_list</var>)\n<dd>"
. $_
. '</dl>');
} }
sub do_env_classdesc{ sub do_env_classdesc{

30
Doc/texinputs/python.sty
View file

@ -116,10 +116,10 @@
\sloppy \sloppy
\parindent = 0mm \parindent = 0mm
\parskip = 2mm \parskip = 2mm
\hbadness = 5000 % don't print trivial gripes \hbadness = 5000 % don't print trivial gripes
\pagestyle{empty} % start this way; change for \pagestyle{empty} % start this way; change for
\pagenumbering{roman} % ToC & chapters \pagenumbering{roman} % ToC & chapters
% Use this to set the font family for headers and other decor: % Use this to set the font family for headers and other decor:
\newcommand{\py@HeaderFamily}{\sffamily} \newcommand{\py@HeaderFamily}{\sffamily}
@ -598,7 +598,7 @@
% Using \renewcommand doesn't work for this, for unknown reasons: % Using \renewcommand doesn't work for this, for unknown reasons:
\global\def\py@thisclass{#1} \global\def\py@thisclass{#1}
\begin{fulllineitems} \begin{fulllineitems}
\item[\code{\bfcode{#1}(\py@varvars{#2})}% \item[\strong{class }\code{\bfcode{#1}(\py@varvars{#2})}%
\index{#1@{\py@idxcode{#1}} (class in \py@thismodule)}] \index{#1@{\py@idxcode{#1}} (class in \py@thismodule)}]
}{\end{fulllineitems}} }{\end{fulllineitems}}
@ -608,7 +608,7 @@
% Using \renewcommand doesn't work for this, for unknown reasons: % Using \renewcommand doesn't work for this, for unknown reasons:
\global\def\py@thisclass{#1} \global\def\py@thisclass{#1}
\begin{fulllineitems} \begin{fulllineitems}
\item[\code{\bfcode{#1}(\py@varvars{#2})}% \item[\strong{exception }\code{\bfcode{#1}(\py@varvars{#2})}%
\index{#1@{\py@idxcode{#1}} (exception in \py@thismodule)}] \index{#1@{\py@idxcode{#1}} (exception in \py@thismodule)}]
}{\end{fulllineitems}} }{\end{fulllineitems}}
@ -678,7 +678,7 @@
% -- for constructor information, use excclassdesc instead % -- for constructor information, use excclassdesc instead
\newenvironment{excdesc}[1]{ \newenvironment{excdesc}[1]{
\begin{fulllineitems} \begin{fulllineitems}
\item[\bfcode{#1}% \item[\strong{exception }\bfcode{#1}%
\index{#1@{\py@idxcode{#1}} (exception in \py@thismodule)}] \index{#1@{\py@idxcode{#1}} (exception in \py@thismodule)}]
}{\end{fulllineitems}} }{\end{fulllineitems}}
@ -753,11 +753,11 @@
}{ }{
\newcommand{\py@url}[1]{{% \newcommand{\py@url}[1]{{%
\pdfannotlink attr{/Border [0 0 0]} user{/S /URI /URI (#1)}% \pdfannotlink attr{/Border [0 0 0]} user{/S /URI /URI (#1)}%
\py@LinkColor% color of the link text \py@LinkColor% color of the link text
\mbox{\small\textsf{#1}}% \mbox{\small\textsf{#1}}%
\py@NormalColor% Turn it back off; these are declarative \py@NormalColor% Turn it back off; these are declarative
\pdfendlink}% and don't appear bound to the current \pdfendlink}% and don't appear bound to the current
}% formatting "box". }% formatting "box".
} }
\let\url=\py@url \let\url=\py@url
\newcommand{\email}[1]{{\small\textsf{#1}}} \newcommand{\email}[1]{{\small\textsf{#1}}}
@ -791,11 +791,11 @@
\newcommand{\member}[1]{\texttt{#1}} \newcommand{\member}[1]{\texttt{#1}}
\newcommand{\method}[1]{\texttt{#1}} \newcommand{\method}[1]{\texttt{#1}}
\newcommand{\pytype}[1]{#1} % built-in Python type \newcommand{\pytype}[1]{#1} % built-in Python type
\newcommand{\cfunction}[1]{\texttt{#1}} \newcommand{\cfunction}[1]{\texttt{#1}}
\newcommand{\ctype}[1]{\texttt{#1}} % C struct or typedef name \newcommand{\ctype}[1]{\texttt{#1}} % C struct or typedef name
\newcommand{\cdata}[1]{\texttt{#1}} % C variable, typically global \newcommand{\cdata}[1]{\texttt{#1}} % C variable, typically global
\newcommand{\mimetype}[1]{{\small\textsf{#1}}} \newcommand{\mimetype}[1]{{\small\textsf{#1}}}
% The \! is a "negative thin space" in math mode. % The \! is a "negative thin space" in math mode.
@ -809,11 +809,11 @@
\index{#1@{#1}}% \index{#1@{#1}}%
\index{environment variables!{#1}}% \index{environment variables!{#1}}%
} }
\newcommand{\makevar}[1]{#1} % variable in a Makefile \newcommand{\makevar}[1]{#1} % variable in a Makefile
\newcommand{\character}[1]{\samp{#1}} \newcommand{\character}[1]{\samp{#1}}
% constants defined in Python modules or C headers, not language constants: % constants defined in Python modules or C headers, not language constants:
\newcommand{\constant}[1]{\code{#1}} % manifest constant, not syntactic \newcommand{\constant}[1]{\code{#1}} % manifest constant, not syntactic
\newcommand{\manpage}[2]{{\emph{#1}(#2)}} \newcommand{\manpage}[2]{{\emph{#1}(#2)}}
\newcommand{\pep}[1]{PEP #1\index{Python Enhancement Proposals!PEP #1}} \newcommand{\pep}[1]{PEP #1\index{Python Enhancement Proposals!PEP #1}}