summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2006-07-29 19:09:01 (GMT)
committerFred Drake <fdrake@acm.org>2006-07-29 19:09:01 (GMT)
commit4a847888a7add3ebd8b38e0525d4fb47aa44411b (patch)
treeb5b60c6546156849d7a0aed56ec5fa9292816ffd
parent84608f0c672725e1f939185943fccf5f9010d7ac (diff)
downloadcpython-4a847888a7add3ebd8b38e0525d4fb47aa44411b.zip
cpython-4a847888a7add3ebd8b38e0525d4fb47aa44411b.tar.gz
cpython-4a847888a7add3ebd8b38e0525d4fb47aa44411b.tar.bz2
document the footnote usage pattern
-rw-r--r--Doc/doc/doc.tex14
-rw-r--r--Doc/ext/newtypes.tex6
2 files changed, 17 insertions, 3 deletions
diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index e4b91ac..9c47289 100644
--- a/Doc/doc/doc.tex
+++ b/Doc/doc/doc.tex
@@ -187,6 +187,20 @@ text contributions are more than welcome as well.
Topics which are not covered in the Apple's style guide will be
discussed in this document if necessary.
+ Footnotes are generally discouraged due to the pain of using
+ footnotes in the HTML conversion of documents. Footnotes may be
+ used when they are the best way to present specific information.
+ When a footnote reference is added at the end of the sentence, it
+ should follow the sentence-ending punctuation. The \LaTeX{} markup
+ should appear something like this:
+
+\begin{verbatim}
+This sentence has a footnote reference.%
+ \footnote{This is the footnote text.}
+\end{verbatim}
+
+ Footnotes may appear in the middle of sentences where appropriate.
+
Many special names are used in the Python documentation, including
the names of operating systems, programming languages, standards
bodies, and the like. Many of these were assigned \LaTeX{} macros
diff --git a/Doc/ext/newtypes.tex b/Doc/ext/newtypes.tex
index 9152883..3672533 100644
--- a/Doc/ext/newtypes.tex
+++ b/Doc/ext/newtypes.tex
@@ -480,7 +480,7 @@ this?
1
\item when we know that deallocation of the object\footnote{This is
true when we know that the object is a basic type, like a string or
- a float} will not cause any
+ a float.} will not cause any
calls back into our type's code
\item when decrementing a reference count in a \member{tp_dealloc}
handler when garbage-collections is not supported\footnote{We relied
@@ -792,9 +792,9 @@ eventually figure out that the list is garbage and free it.
In the second version of the \class{Noddy} example, we allowed any
kind of object to be stored in the \member{first} or \member{last}
-attributes\footnote{Even in the third version, we aren't guaranteed to
+attributes.\footnote{Even in the third version, we aren't guaranteed to
avoid cycles. Instances of string subclasses are allowed and string
-subclasses could allow cycles even if normal strings don't.}. This
+subclasses could allow cycles even if normal strings don't.} This
means that \class{Noddy} objects can participate in cycles:
\begin{verbatim}