summaryrefslogtreecommitdiffstats
path: root/Doc/ref/ref7.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1998-05-14 19:37:06 (GMT)
committerFred Drake <fdrake@acm.org>1998-05-14 19:37:06 (GMT)
commit5c07d9b028898792b19b3845786d6565d11c4aba (patch)
tree9bdc8fdeca1a698d62912ab15feb70452ddcfdb5 /Doc/ref/ref7.tex
parent2094e044c78fa2df7143d4edb5ddf35ce49bdd95 (diff)
downloadcpython-5c07d9b028898792b19b3845786d6565d11c4aba.zip
cpython-5c07d9b028898792b19b3845786d6565d11c4aba.tar.gz
cpython-5c07d9b028898792b19b3845786d6565d11c4aba.tar.bz2
Updated markup style (got rid of \verb@...@, mostly).
Diffstat (limited to 'Doc/ref/ref7.tex')
-rw-r--r--Doc/ref/ref7.tex124
1 files changed, 63 insertions, 61 deletions
diff --git a/Doc/ref/ref7.tex b/Doc/ref/ref7.tex
index f5b8a0e..f012c00 100644
--- a/Doc/ref/ref7.tex
+++ b/Doc/ref/ref7.tex
@@ -6,8 +6,8 @@ or control the execution of those other statements in some way. In
general, compound statements span multiple lines, although in simple
incarnations a whole compound statement may be contained in one line.
-The \verb@if@, \verb@while@ and \verb@for@ statements implement
-traditional control flow constructs. \verb@try@ specifies exception
+The \keyword{if}, \keyword{while} and \keyword{for} statements implement
+traditional control flow constructs. \keyword{try} specifies exception
handlers and/or cleanup code for a group of statements. Function and
class definitions are also syntactically compound statements.
@@ -21,7 +21,7 @@ statements on the same line as the header, following the header's
colon, or it can be one or more indented statements on subsequent
lines. Only the latter form of suite can contain nested compound
statements; the following is illegal, mostly because it wouldn't be
-clear to which \verb@if@ clause a following \verb@else@ clause would
+clear to which \keyword{if} clause a following \keyword{else} clause would
belong:
\index{clause}
\index{suite}
@@ -32,7 +32,7 @@ if test1: if test2: print x
Also note that the semicolon binds tighter than the colon in this
context, so that in the following example, either all or none of the
-\verb@print@ statements are executed:
+\keyword{print} statements are executed:
\begin{verbatim}
if x < y < z: print x; print y; print z
@@ -48,24 +48,24 @@ statement: stmt_list NEWLINE | compound_stmt
stmt_list: simple_stmt (";" simple_stmt)* [";"]
\end{verbatim}
-Note that statements always end in a \verb@NEWLINE@ possibly followed
-by a \verb@DEDENT@.
+Note that statements always end in a \code{NEWLINE} possibly followed
+by a \code{DEDENT}.
\index{NEWLINE token}
\index{DEDENT token}
Also note that optional continuation clauses always begin with a
keyword that cannot start a statement, thus there are no ambiguities
-(the `dangling \verb@else@' problem is solved in Python by requiring
-nested \verb@if@ statements to be indented).
+(the `dangling \keyword{else}' problem is solved in Python by requiring
+nested \keyword{if} statements to be indented).
\indexii{dangling}{else}
The formatting of the grammar rules in the following sections places
each clause on a separate line for clarity.
-\section{The {\tt if} statement}
+\section{The \keyword{if} statement}
\stindex{if}
-The \verb@if@ statement is used for conditional execution:
+The \keyword{if} statement is used for conditional execution:
\begin{verbatim}
if_stmt: "if" condition ":" suite
@@ -76,17 +76,17 @@ if_stmt: "if" condition ":" suite
It selects exactly one of the suites by evaluating the conditions one
by one until one is found to be true (see section \ref{Booleans} for
the definition of true and false); then that suite is executed (and no
-other part of the \verb@if@ statement is executed or evaluated). If
-all conditions are false, the suite of the \verb@else@ clause, if
+other part of the \keyword{if} statement is executed or evaluated). If
+all conditions are false, the suite of the \keyword{else} clause, if
present, is executed.
\kwindex{elif}
\kwindex{else}
-\section{The {\tt while} statement}
+\section{The \keyword{while} statement}
\stindex{while}
\indexii{loop}{statement}
-The \verb@while@ statement is used for repeated execution as long as a
+The \keyword{while} statement is used for repeated execution as long as a
condition is true:
\begin{verbatim}
@@ -96,22 +96,22 @@ while_stmt: "while" condition ":" suite
This repeatedly tests the condition and, if it is true, executes the
first suite; if the condition is false (which may be the first time it
-is tested) the suite of the \verb@else@ clause, if present, is
+is tested) the suite of the \keyword{else} clause, if present, is
executed and the loop terminates.
\kwindex{else}
-A \verb@break@ statement executed in the first suite terminates the
-loop without executing the \verb@else@ clause's suite. A
-\verb@continue@ statement executed in the first suite skips the rest
+A \keyword{break} statement executed in the first suite terminates the
+loop without executing the \keyword{else} clause's suite. A
+\keyword{continue} statement executed in the first suite skips the rest
of the suite and goes back to testing the condition.
\stindex{break}
\stindex{continue}
-\section{The {\tt for} statement}
+\section{The \keyword{for} statement}
\stindex{for}
\indexii{loop}{statement}
-The \verb@for@ statement is used to iterate over the elements of a
+The \keyword{for} statement is used to iterate over the elements of a
sequence (string, tuple or list):
\obindex{sequence}
@@ -125,16 +125,16 @@ suite is then executed once for each item in the sequence, in the
order of ascending indices. Each item in turn is assigned to the
target list using the standard rules for assignments, and then the
suite is executed. When the items are exhausted (which is immediately
-when the sequence is empty), the suite in the \verb@else@ clause, if
+when the sequence is empty), the suite in the \keyword{else} clause, if
present, is executed, and the loop terminates.
\kwindex{in}
\kwindex{else}
\indexii{target}{list}
-A \verb@break@ statement executed in the first suite terminates the
-loop without executing the \verb@else@ clause's suite. A
-\verb@continue@ statement executed in the first suite skips the rest
-of the suite and continues with the next item, or with the \verb@else@
+A \keyword{break} statement executed in the first suite terminates the
+loop without executing the \keyword{else} clause's suite. A
+\keyword{continue} statement executed in the first suite skips the rest
+of the suite and continues with the next item, or with the \keyword{else}
clause if there was no next item.
\stindex{break}
\stindex{continue}
@@ -146,14 +146,14 @@ The target list is not deleted when the loop is finished, but if the
sequence is empty, it will not have been assigned to at all by the
loop.
-Hint: the built-in function \verb@range()@ returns a sequence of
+Hint: the built-in function \function{range()} returns a sequence of
integers suitable to emulate the effect of Pascal's
-\verb@for i := a to b do@;
-e.g. \verb@range(3)@ returns the list \verb@[0, 1, 2]@.
+\code{for i := a to b do};
+e.g. \code{range(3)} returns the list \code{[0, 1, 2]}.
\bifuncindex{range}
-\index{Pascal}
+\indexii{Pascal}{language}
-{\bf Warning:} There is a subtlety when the sequence is being modified
+\strong{Warning:} There is a subtlety when the sequence is being modified
by the loop (this can only occur for mutable sequences, i.e. lists).
An internal counter is used to keep track of which item is used next,
and this is incremented on each iteration. When this counter has
@@ -173,10 +173,10 @@ for x in a[:]:
if x < 0: a.remove(x)
\end{verbatim}
-\section{The {\tt try} statement} \label{try}
+\section{The \keyword{try} statement} \label{try}
\stindex{try}
-The \verb@try@ statement specifies exception handlers and/or cleanup
+The \keyword{try} statement specifies exception handlers and/or cleanup
code for a group of statements:
\begin{verbatim}
@@ -188,13 +188,15 @@ try_fin_stmt: "try" ":" suite
"finally" ":" suite
\end{verbatim}
-There are two forms of \verb@try@ statement: \verb@try...except@ and
-\verb@try...finally@. These forms cannot be mixed.
+There are two forms of \keyword{try} statement:
+\keyword{try}...\keyword{except} and
+\keyword{try}...\keyword{finally}. These forms cannot be mixed.
-The \verb@try...except@ form specifies one or more exception handlers
-(the \verb@except@ clauses). When no exception occurs in the
-\verb@try@ clause, no exception handler is executed. When an
-exception occurs in the \verb@try@ suite, a search for an exception
+The \keyword{try}...\keyword{except} form specifies one or more
+exception handlers
+(the \keyword{except} clauses). When no exception occurs in the
+\keyword{try} clause, no exception handler is executed. When an
+exception occurs in the \keyword{try} suite, a search for an exception
handler is started. This inspects the except clauses in turn until
one is found that matches the exception. A condition-less except
clause, if present, must be last; it matches any exception. For an
@@ -214,7 +216,7 @@ handler continues in the surrounding code and on the invocation stack.
If the evaluation of a condition in the header of an except clause
raises an exception, the original search for a handler is cancelled
and a search starts for the new exception in the surrounding code and
-on the call stack (it is treated as if the entire \verb@try@ statement
+on the call stack (it is treated as if the entire \keyword{try} statement
raised the exception).
When a matching except clause is found, the exception's parameter is
@@ -226,10 +228,10 @@ exception, and the exception occurs in the try clause of the inner
handler, the outer handler will not handle the exception.)
Before an except clause's suite is executed, details about the
-exception are assigned to three variables in the \verb@sys@ module:
-\verb@sys.exc_type@ receives the object identifying the exception;
-\verb@sys.exc_value@ receives the exception's parameter;
-\verb@sys.exc_traceback@ receives a traceback object (see section
+exception are assigned to three variables in the \module{sys} module:
+\code{sys.exc_type} receives the object identifying the exception;
+\code{sys.exc_value} receives the exception's parameter;
+\code{sys.exc_traceback} receives a traceback object (see section
\ref{traceback}) identifying the point in the program where the
exception occurred.
\refbimodindex{sys}
@@ -238,25 +240,25 @@ exception occurred.
\ttindex{exc_traceback}
\obindex{traceback}
-The optional \verb@else@ clause is executed when no exception occurs
-in the \verb@try@ clause. Exceptions in the \verb@else@ clause are
-not handled by the preceding \verb@except@ clauses.
+The optional \keyword{else} clause is executed when no exception occurs
+in the \keyword{try} clause. Exceptions in the \keyword{else} clause are
+not handled by the preceding \keyword{except} clauses.
\kwindex{else}
-The \verb@try...finally@ form specifies a `cleanup' handler. The
-\verb@try@ clause is executed. When no exception occurs, the
-\verb@finally@ clause is executed. When an exception occurs in the
-\verb@try@ clause, the exception is temporarily saved, the
-\verb@finally@ clause is executed, and then the saved exception is
-re-raised. If the \verb@finally@ clause raises another exception or
-executes a \verb@return@, \verb@break@ or \verb@continue@ statement,
+The \keyword{try}...\keyword{finally} form specifies a `cleanup' handler. The
+\keyword{try} clause is executed. When no exception occurs, the
+\keyword{finally} clause is executed. When an exception occurs in the
+\keyword{try} clause, the exception is temporarily saved, the
+\keyword{finally} clause is executed, and then the saved exception is
+re-raised. If the \keyword{finally} clause raises another exception or
+executes a \keyword{return}, \keyword{break} or \keyword{continue} statement,
the saved exception is lost.
\kwindex{finally}
-When a \verb@return@ or \verb@break@ statement is executed in the
-\verb@try@ suite of a \verb@try...finally@ statement, the
-\verb@finally@ clause is also executed `on the way out'. A
-\verb@continue@ statement is illegal in the \verb@try@ clause. (The
+When a \keyword{return} or \keyword{break} statement is executed in the
+\keyword{try} suite of a \keyword{try}...\keyword{finally} statement, the
+\keyword{finally} clause is also executed `on the way out'. A
+\keyword{continue} statement is illegal in the \keyword{try} clause. (The
reason is a problem with the current implementation --- this
restriction may be lifted in the future).
\stindex{return}
@@ -295,7 +297,7 @@ as the global name space to be used when the function is called.
The function definition does not execute the function body; this gets
executed only when the function is called.
-When one or more top-level parameters have the form {\em parameter =
+When one or more top-level parameters have the form \var{parameter \code{=}
condition}, the function is said to have ``default parameter values''.
Default parameter values are evaluated when the function definition is
executed. For a parameter with a default value, the correponding
@@ -304,7 +306,7 @@ default value is substituted. If a parameter has a default value, all
following parameters must also have a default value --- this is a
syntactic restriction that is not expressed by the grammar.%
\footnote{Currently this is not checked; instead,
-{\tt def f(a=1,b)} is interpreted as {\tt def f(a=1,b=None)}.}
+\code{def f(a=1, b)} is interpreted as \code{def f(a=1, b=None)}.}
\indexiii{default}{parameter}{value}
Function call semantics are described in section \ref{calls}. When a
@@ -338,11 +340,11 @@ hand side's value is that of the argument.
If the formal parameter list ends in a star followed by an identifier,
preceded by zero or more comma-followed parameters, there must be at
least as many arguments as there are parameters preceding the star.
-Call this number {\em N}. The first {\em N} arguments are assigned to
+Call this number \var{N}. The first \var{N} arguments are assigned to
the corresponding formal parameters in the way descibed above. A
tuple containing the remaining arguments, if any, is then assigned to
the identifier following the star. This variable will always be a
-tuple: if there are no extra arguments, its value is \verb@()@, if
+tuple: if there are no extra arguments, its value is \code{()}, if
there is just one extra argument, it is a singleton tuple.
\indexii{variable length}{parameter list}