summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1999-05-11 15:42:51 (GMT)
committerFred Drake <fdrake@acm.org>1999-05-11 15:42:51 (GMT)
commit84bd6f3b18766405e701c7edaa0b8ed94f8ba391 (patch)
treee02693cef807939ac94b3d70af4f757426dc4c39
parent03c05a51927b31e18a1185ea1a9f79806a348c20 (diff)
downloadcpython-84bd6f3b18766405e701c7edaa0b8ed94f8ba391.zip
cpython-84bd6f3b18766405e701c7edaa0b8ed94f8ba391.tar.gz
cpython-84bd6f3b18766405e701c7edaa0b8ed94f8ba391.tar.bz2
Change the look of \seemodule output to fit in better.
-rw-r--r--Doc/perl/python.perl12
-rw-r--r--Doc/texinputs/python.sty26
2 files changed, 24 insertions, 14 deletions
diff --git a/Doc/perl/python.perl b/Doc/perl/python.perl
index 2b6fa18..67bac72 100644
--- a/Doc/perl/python.perl
+++ b/Doc/perl/python.perl
@@ -1081,12 +1081,16 @@ sub do_cmd_seemodule{
my $key = next_optional_argument();
my $module = next_argument();
my $text = next_argument();
+ my $period = '.';
$key = $module
unless $key;
- return '<div class=seemodule>'
- . "\n<p>Module <b><tt class=module><a href=\"module-$key.html\">"
- . "$module</a></tt></b>"
- . "&nbsp;&nbsp;&nbsp;($text)</p>\n</div>"
+ if ($text =~ /\.$/) {
+ $period = '';
+ }
+ return '<dl compact class=seemodule>'
+ . "\n <dt>Module <b><tt class=module><a href=\"module-$key.html\">"
+ . "$module</a></tt>:</b>"
+ . "\n <dd>$text$period\n </dl>"
. $_;
}
diff --git a/Doc/texinputs/python.sty b/Doc/texinputs/python.sty
index 30fef21..c8d3691 100644
--- a/Doc/texinputs/python.sty
+++ b/Doc/texinputs/python.sty
@@ -821,28 +821,34 @@
% Cross-referencing (AMK, new impl. FLD)
% Sample usage:
% \begin{seealso}
-% \seemodule{rand}{Uniform random number generator}; % Module xref
-% \seetext{\emph{Encyclopedia Britannica}}. % Ref to a book
+% \seemodule{rand}{Uniform random number generator.}; % Module xref
+% \seetext{\emph{Encyclopedia Britannica}}. % Ref to a book
%
% % A funky case: module name contains '_'; have to supply an optional key
-% \seemodule[copyreg]{copy_reg}{pickle interface constructor registration}
-%
+% \seemodule[copyreg]{copy_reg}{Interface constructor registration for
+% \module{pickle}.}
% \end{seealso}
+%
+% Note that the last parameter for \seemodule and \seetext should be complete
+% sentences and be terminated with the proper punctuation.
\@ifundefined{pdfannotlink}{%
\newcommand{\py@seemodule}[3][\py@modulebadkey]{%
\par%
\ifx\py@modulebadkey#1\def\py@modulekey{#2}\else\def\py@modulekey{#1}\fi%
- \ref{module-\py@modulekey}:\quad %
- Module \module{#2}%
- \quad (#3)%
+ \begin{fulllineitems}
+ \item[Module \module{#2} (section \ref{module-\py@modulekey}):]
+ #3
+ \end{fulllineitems}
}
}{\newcommand{\py@seemodule}[3][\py@modulebadkey]{%
\par%
\ifx\py@modulebadkey#1\def\py@modulekey{#2}\else\def\py@modulekey{#1}\fi%
- \ref{module-\py@modulekey}:\quad %
- \py@linkToName{label-module-\py@modulekey}{ Module \module{#2} }
- \quad (#3)%
+ \begin{fulllineitems}
+ \item[\py@linkToName{label-module-\py@modulekey}{Module \module{#2}}
+ (section \ref{module-\py@modulekey}):]
+ #3
+ \end{fulllineitems}
}
}
\newenvironment{seealso}[0]{