summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libmarshal.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1998-03-08 06:28:00 (GMT)
committerFred Drake <fdrake@acm.org>1998-03-08 06:28:00 (GMT)
commit0c2af2bef6dc1a66d2678ec2a2ca820556ab8db3 (patch)
tree1720359327ac6c6ec573637e92e3a984eb0d3b89 /Doc/lib/libmarshal.tex
parent266b4c1506d8cd40f9f4cb74127ad0d53de904ca (diff)
downloadcpython-0c2af2bef6dc1a66d2678ec2a2ca820556ab8db3.zip
cpython-0c2af2bef6dc1a66d2678ec2a2ca820556ab8db3.tar.gz
cpython-0c2af2bef6dc1a66d2678ec2a2ca820556ab8db3.tar.bz2
Spell emdash with three hyphens.
Minor nits.
Diffstat (limited to 'Doc/lib/libmarshal.tex')
-rw-r--r--Doc/lib/libmarshal.tex12
1 files changed, 5 insertions, 7 deletions
diff --git a/Doc/lib/libmarshal.tex b/Doc/lib/libmarshal.tex
index 4a25ab1..a2a8084 100644
--- a/Doc/lib/libmarshal.tex
+++ b/Doc/lib/libmarshal.tex
@@ -1,7 +1,7 @@
\section{Built-in Module \sectcode{marshal}}
\label{module-marshal}
-
\bimodindex{marshal}
+
This module contains functions that can read and write Python
values in a binary format. The format is specific to Python, but
independent of machine architecture issues (e.g., you can write a
@@ -54,16 +54,14 @@ operating on strings.
The module defines these functions:
-\setindexsubitem{(in module marshal)}
-
-\begin{funcdesc}{dump}{value\, file}
+\begin{funcdesc}{dump}{value, file}
Write the value on the open file. The value must be a supported
type. The file must be an open file object such as
\code{sys.stdout} or returned by \function{open()} or
\function{posix.popen()}.
If the value has (or contains an object that has) an unsupported type,
- a \exception{ValueError} exception is raised -- but garbage data
+ a \exception{ValueError} exception is raised --- but garbage data
will also be written to the file. The object will not be properly
read back by \function{load()}.
\end{funcdesc}
@@ -73,8 +71,8 @@ The module defines these functions:
is read, raise \exception{EOFError}, \exception{ValueError} or
\exception{TypeError}. The file must be an open file object.
- Warning: If an object containing an unsupported type was marshalled
- with \function{dump()}, \function{load()} will substitute
+ \strong{Warning:} If an object containing an unsupported type was
+ marshalled with \function{dump()}, \function{load()} will substitute
\code{None} for the unmarshallable type.
\end{funcdesc}