summaryrefslogtreecommitdiffstats
path: root/Doc/doc
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2004-01-08 14:57:27 (GMT)
committerFred Drake <fdrake@acm.org>2004-01-08 14:57:27 (GMT)
commit4f687b305162d8e3babc72eda37fd88bba40b1b2 (patch)
tree66f797f0b81ed43ce9507f60ae9bb0da9f48c56c /Doc/doc
parent91f5cbe264682e180216d6cafb358d5e1964d41d (diff)
downloadcpython-4f687b305162d8e3babc72eda37fd88bba40b1b2.zip
cpython-4f687b305162d8e3babc72eda37fd88bba40b1b2.tar.gz
cpython-4f687b305162d8e3babc72eda37fd88bba40b1b2.tar.bz2
add new reference macro: \seelink
Diffstat (limited to 'Doc/doc')
-rw-r--r--Doc/doc/doc.tex11
1 files changed, 10 insertions, 1 deletions
diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index 2270968..aacce2f 100644
--- a/Doc/doc/doc.tex
+++ b/Doc/doc/doc.tex
@@ -1395,11 +1395,20 @@ This \UNIX\ is also followed by a space.
For each of the following macros, \var{why} should be one or more
complete sentences, starting with a capital letter (unless it
starts with an identifier, which should not be modified), and
- ending with the apropriate punctuation.
+ ending with the appropriate punctuation.
These macros are only defined within the content of the
\env{seealso} and \env{seealso*} environments.
+ \begin{macrodesc}{seelink}{\p{url}\p{linktext}\p{why}}
+ References to specific on-line resources should be given using
+ the \macro{seelink} macro if they don't have a meaningful title
+ but there is some short description of what's at the end of the
+ link. Online documents which have identifiable titles should be
+ referenced using the \macro{seetitle} macro, using the optional
+ parameter to that macro to provide the URL.
+ \end{macrodesc}
+
\begin{macrodesc}{seemodule}{\op{key}\p{name}\p{why}}
Refer to another module. \var{why} should be a brief
explanation of why the reference may be interesting. The module