mirror of
https://github.com/python/cpython.git
synced 2025-08-04 00:48:58 +00:00
SF Patch #1093896: miscellaneous doc typos
This commit is contained in:
parent
f871d833dd
commit
68804315e0
60 changed files with 103 additions and 102 deletions
|
@ -204,7 +204,7 @@ text contributions are more than welcome as well.
|
|||
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
|
||||
be avoided since there's no reasonable way to predict which occurrence
|
||||
will be the first seen by the reader. It is better to use the
|
||||
word ``processor'' instead.
|
||||
|
||||
|
@ -471,7 +471,7 @@ This \UNIX\ is also followed by a space.
|
|||
|
||||
\LaTeX{} provides a variety of environments even without the
|
||||
additional markup provided by the Python-specific document classes
|
||||
introducted in the next section. The following environments are
|
||||
introduced in the next section. The following environments are
|
||||
provided as part of standard \LaTeX{} and are being used in the
|
||||
standard Python documentation; descriptions will be added here as
|
||||
time allows.
|
||||
|
@ -651,7 +651,7 @@ verbatim
|
|||
\end{envdesc}
|
||||
|
||||
\begin{envdesc}{excclassdesc}{\p{name}\p{constructor parameters}}
|
||||
Descibe an exception defined by a class. \var{constructor
|
||||
Describe an exception defined by a class. \var{constructor
|
||||
parameters} should not include the \var{self} parameter or
|
||||
the parentheses used in the call syntax. To describe an
|
||||
exception class without describing the parameters to its
|
||||
|
@ -830,7 +830,7 @@ verbatim
|
|||
with release \var{version}. The text given as \var{what to do}
|
||||
should recommend something to use instead. It should be
|
||||
complete sentences. The entire deprecation notice will be
|
||||
presented as a separate paragraph; it should either preceed or
|
||||
presented as a separate paragraph; it should either precede or
|
||||
succeed the description of the deprecated feature.
|
||||
\end{macrodesc}
|
||||
|
||||
|
@ -1122,7 +1122,7 @@ verbatim
|
|||
|
||||
\begin{envdesc}{notice}{\op{type}}
|
||||
Label some paragraphs as being worthy of additional attention from
|
||||
the reader. What sort of attention is warrented can be indicated
|
||||
the reader. What sort of attention is warranted can be indicated
|
||||
by specifying the \var{type} of the notice. The only values
|
||||
defined for \var{type} are \code{note} and \code{warning}; these
|
||||
are equivalent in intent to the inline markup of the same name.
|
||||
|
@ -1660,7 +1660,7 @@ verbatim
|
|||
\begin{envdesc}{productionlist}{\op{language}}
|
||||
This environment is used to enclose a group of productions. The
|
||||
two macros are only defined within this environment. If a
|
||||
document descibes more than one language, the optional parameter
|
||||
document describes more than one language, the optional parameter
|
||||
\var{language} should be used to distinguish productions between
|
||||
languages. The value of the parameter should be a short name
|
||||
that can be used as part of a filename; colons or other
|
||||
|
@ -1731,7 +1731,7 @@ verbatim
|
|||
a complete sequence of menu selections, including selecting
|
||||
submenus and choosing a specific operation, or any subsequence of
|
||||
such a sequence. The names of individual selections should be
|
||||
separated by occurances of \macro{sub}.
|
||||
separated by occurrences of \macro{sub}.
|
||||
|
||||
For example, to mark the selection ``\menuselection{Start \sub
|
||||
Programs}'', use this markup:
|
||||
|
@ -2080,7 +2080,7 @@ mydoc.ps: mydoc.tex mygraphic.eps
|
|||
fairly rough.
|
||||
|
||||
The timeframe for the conversion is not clear since there doesn't
|
||||
seem to be much time available to work on this, but the appearant
|
||||
seem to be much time available to work on this, but the apparent
|
||||
benefits are growing more substantial at a moderately rapid pace.
|
||||
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue