Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

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.
This commit is contained in:
Fred Drake 2001-07-14 02:34:12 +00:00
parent 7a889ceb1e
commit 9120df388c
1 changed files with 24 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
Doc/doc/doc.tex
View File

@ -11,7 +11,7 @@
\author{Fred L. Drake, Jr.} \author{Fred L. Drake, Jr.}
\authoraddress{ \authoraddress{
PythonLabs \\ PythonLabs \\
E-mail: \email{fdrake@acm.org} Email: \email{fdrake@acm.org}
} }
@ -170,15 +170,27 @@ distribution, to create or maintain whole documents or sections.
the names of operating systems, programming languages, standards the names of operating systems, programming languages, standards
bodies, and the like. Many of these were assigned \LaTeX{} macros bodies, and the like. Many of these were assigned \LaTeX{} macros
at some point in the distant past, and these macros lived on long at some point in the distant past, and these macros lived on long
past their usefulness. In the current markup, these entities are past their usefulness. In the current markup, most of these entities
not assigned any special markup, but the preferred spellings are are not assigned any special markup, but the preferred spellings are
given here to aid authors in maintaining the consistency of given here to aid authors in maintaining the consistency of
presentation in the Python documentation. 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} \begin{description}
\item[POSIX] \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 The name assigned to a particular group of standards. This is
always uppercase. always uppercase. Use the macro \macro{POSIX} to represent this
name.
\item[Python] \item[Python]
The name of our favorite programming language is always The name of our favorite programming language is always
@ -186,7 +198,11 @@ distribution, to create or maintain whole documents or sections.
\item[Unicode] \item[Unicode]
The name of a character set and matching encoding. This is The name of a character set and matching encoding. This is
always written capitalized. 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} \end{description}
@ -828,7 +844,7 @@ This \UNIX\ is also followed by a space.
\end{macrodesc} \end{macrodesc}
\begin{macrodesc}{newsgroup}{\p{name}} \begin{macrodesc}{newsgroup}{\p{name}}
The name of a USENET newsgroup. The name of a Usenet newsgroup.
\end{macrodesc} \end{macrodesc}
\begin{macrodesc}{pep}{\p{number}} \begin{macrodesc}{pep}{\p{number}}
@ -975,7 +991,7 @@ This \UNIX\ is also followed by a space.
\declaremodule{extension}{spam} \declaremodule{extension}{spam}
\platform{Unix} \platform{Unix}
\modulesynopsis{Access to the SPAM facility of \UNIX{}.} \modulesynopsis{Access to the SPAM facility of \UNIX.}
\moduleauthor{Jane Doe}{jane.doe@frobnitz.org} \moduleauthor{Jane Doe}{jane.doe@frobnitz.org}
\end{verbatim} \end{verbatim}