[Python-checkins] CVS: python/dist/src/Doc/doc doc.tex,1.45,1.46
Fred L. Drake
fdrake@users.sourceforge.net
Fri, 13 Jul 2001 19:34:15 -0700
Update of /cvsroot/python/python/dist/src/Doc/doc
In directory usw-pr-cvs1:/tmp/cvs-serv20695/doc
Modified Files:
doc.tex
Log Message:
Add a little more information about the usage of some terms where the
style guide can use a little clarification, and present some minor
specific markup.
Make a few adjustments to conform to the style guide.
Index: doc.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/doc/doc.tex,v
retrieving revision 1.45
retrieving revision 1.46
diff -C2 -r1.45 -r1.46
*** doc.tex 2001/07/12 02:08:29 1.45
--- doc.tex 2001/07/14 02:34:12 1.46
***************
*** 12,16 ****
\authoraddress{
PythonLabs \\
! E-mail: \email{fdrake@acm.org}
}
--- 12,16 ----
\authoraddress{
PythonLabs \\
! Email: \email{fdrake@acm.org}
}
***************
*** 171,183 ****
bodies, and the like. Many of these were assigned \LaTeX{} macros
at some point in the distant past, and these macros lived on long
! past their usefulness. In the current markup, these entities are
! not assigned any special markup, but the preferred spellings are
given here to aid authors in maintaining the consistency of
presentation in the Python documentation.
\begin{description}
! \item[POSIX]
The name assigned to a particular group of standards. This is
! always uppercase.
\item[Python]
--- 171,195 ----
bodies, and the like. Many of these were assigned \LaTeX{} macros
at some point in the distant past, and these macros lived on long
! past their usefulness. In the current markup, most of these entities
! are not assigned any special markup, but the preferred spellings are
given here to aid authors in maintaining the consistency of
presentation in the Python documentation.
+ Other terms and words deserve special mention as well; these conventions
+ should be used to ensure consistency throughout the documentation:
+
\begin{description}
! \item[CPU]
! For ``central processing unit.'' Many style guides say this
! should be spelled out on the first use (and if you must use it,
! do so!). For the Python documentation, this abbreviation should
! be avoided since there's no reasonable way to predict which occurance
! will be the first seen by the reader. It is better to use the
! word ``processor'' instead.
!
! \item[\POSIX]
The name assigned to a particular group of standards. This is
! always uppercase. Use the macro \macro{POSIX} to represent this
! name.
\item[Python]
***************
*** 187,191 ****
\item[Unicode]
The name of a character set and matching encoding. This is
! always written capitalized.
\end{description}
--- 199,207 ----
\item[Unicode]
The name of a character set and matching encoding. This is
! always written capitalized.
!
! \item[\UNIX]
! The name of the operating system developed at AT\&T Bell Labs
! in the early 1970s. Use the macro \macro{UNIX} to use this name.
\end{description}
***************
*** 829,833 ****
\begin{macrodesc}{newsgroup}{\p{name}}
! The name of a USENET newsgroup.
\end{macrodesc}
--- 845,849 ----
\begin{macrodesc}{newsgroup}{\p{name}}
! The name of a Usenet newsgroup.
\end{macrodesc}
***************
*** 976,980 ****
\declaremodule{extension}{spam}
\platform{Unix}
! \modulesynopsis{Access to the SPAM facility of \UNIX{}.}
\moduleauthor{Jane Doe}{jane.doe@frobnitz.org}
\end{verbatim}
--- 992,996 ----
\declaremodule{extension}{spam}
\platform{Unix}
! \modulesynopsis{Access to the SPAM facility of \UNIX.}
\moduleauthor{Jane Doe}{jane.doe@frobnitz.org}
\end{verbatim}