Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 4c6f17a

Browse files
committed
Make a number of small clarifications and correct a whole bunch of typos,
all reported by Bruce Smith.
1 parent 635a7cf commit 4c6f17a

1 file changed

Lines changed: 18 additions & 15 deletions

File tree

Doc/doc/doc.tex

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -192,12 +192,14 @@ \section{\LaTeX{} Primer \label{latex-primer}}
192192

193193
The document body follows the preamble. This contains all the
194194
printed components of the document marked up structurally. Generic
195-
\LaTeX{} structures include hierarchical sections
195+
\LaTeX{} structures include hierarchical sections, numbered and
196+
bulleted lists, and special structures for the document abstract and
197+
indexes.
196198

197199
\subsection{Syntax}
198200

199-
There are a things that an author of Python documentation needs to
200-
know about \LaTeX{} syntax.
201+
There are some things that an author of Python documentation needs
202+
to know about \LaTeX{} syntax.
201203

202204
A \dfn{comment} is started by the ``percent'' character
203205
(\character{\%}) and continues through the end of the line and all
@@ -235,7 +237,7 @@ \section{\LaTeX{} Primer \label{latex-primer}}
235237
{text in a group}
236238
\end{verbatim}
237239

238-
An alternate syntax for a group using brackets (\code{[...]}) is
240+
An alternate syntax for a group using brackets, \code{[...]}, is
239241
used by macros and environment constructors which take optional
240242
parameters; brackets do not normally hold syntactic significance.
241243
A degenerate group, containing only one atomic bit of content,
@@ -246,7 +248,7 @@ \section{\LaTeX{} Primer \label{latex-primer}}
246248
Groups are used only sparingly in the Python documentation, except
247249
for their use in marking parameters to macros and environments.
248250

249-
A \dfn{macro} is usually simple construct which is identified by
251+
A \dfn{macro} is usually a simple construct which is identified by
250252
name and can take some number of parameters. In normal \LaTeX{}
251253
usage, one of these can be optional. The markup is introduced
252254
using the backslash character (\character{\e}), and the name is
@@ -279,14 +281,14 @@ \section{\LaTeX{} Primer \label{latex-primer}}
279281
A macro name may be followed by a space or newline; a space
280282
between the macro name and any parameters will be consumed, but
281283
this usage is not practiced in the Python documentation. Such a
282-
space is still consumed if there are no parameters to the marco,
284+
space is still consumed if there are no parameters to the macro,
283285
in which case inserting an empty group (\code{\{\}}) or explicit
284286
word space (\samp{\e\ }) immediately after the macro name helps to
285287
avoid running the expansion of the macro into the following text.
286288
Macros which take no parameters but which should not be followed
287289
by a word space do not need special treatment if the following
288290
character in the document source if not a name character (such as
289-
puctuation).
291+
punctuation).
290292

291293
Each line of this example shows an appropriate way to write text
292294
which includes a macro which takes no parameters:
@@ -298,12 +300,12 @@ \section{\LaTeX{} Primer \label{latex-primer}}
298300
\end{verbatim}
299301

300302
An \dfn{environment} is a larger construct than a macro, and can
301-
be used for things with more content that would conveniently fit
303+
be used for things with more content than would conveniently fit
302304
in a macro parameter. They are primarily used when formatting
303305
parameters need to be changed before and after a large chunk of
304306
content, but the content itself needs to be highly flexible. Code
305307
samples are presented using an environment, and descriptions of
306-
functions, methods, and classes are also marked using envionments.
308+
functions, methods, and classes are also marked using environments.
307309

308310
Since the content of an environment is free-form and can consist
309311
of several paragraphs, they are actually marked using a pair of
@@ -333,11 +335,11 @@ \section{\LaTeX{} Primer \label{latex-primer}}
333335
\end{datadesc}
334336
\end{verbatim}
335337

336-
There are a number of less-used marks in \LaTeX{} are used to
337-
enter non-\ASCII{} characters, especially those used in European
338-
names. Given that these are often used adjacent to other
338+
There are a number of less-used marks in \LaTeX{} which are used
339+
to enter non-\ASCII{} characters, especially those used in
340+
European names. Given that these are often used adjacent to other
339341
characters, the markup required to produce the proper character
340-
may need to be followed by a space or an empty group, or the the
342+
may need to be followed by a space or an empty group, or the
341343
markup can be enclosed in a group. Some which are found in Python
342344
documentation are:
343345

@@ -357,8 +359,9 @@ \section{\LaTeX{} Primer \label{latex-primer}}
357359
safely inferred when a section of equal or higher level starts.
358360

359361
There are six ``levels'' of sectioning in the document classes
360-
used for Python documentation, and the lowest two levels are not
361-
used. The levels are:
362+
used for Python documentation, and the deepest two
363+
levels\footnote{The deepest levels have the highest numbers in the
364+
table.} are not used. The levels are:
362365

363366
\begin{tableiii}{c|l|c}{textrm}{Level}{Macro Name}{Notes}
364367
\lineiii{1}{\macro{chapter}}{(1)}

0 commit comments

Comments
 (0)