diff options
author | Fred Drake <fdrake@acm.org> | 2002-06-17 15:44:18 (GMT) |
---|---|---|
committer | Fred Drake <fdrake@acm.org> | 2002-06-17 15:44:18 (GMT) |
commit | b084017c7a27ab37ef6918aaf7e0f665c0dbe2ed (patch) | |
tree | 770c72a05c0d2a6305039581211ab97728a551dd /Doc | |
parent | 6fc22f6c3d566587247510d5b255ccbb564c73f4 (diff) | |
download | cpython-b084017c7a27ab37ef6918aaf7e0f665c0dbe2ed.zip cpython-b084017c7a27ab37ef6918aaf7e0f665c0dbe2ed.tar.gz cpython-b084017c7a27ab37ef6918aaf7e0f665c0dbe2ed.tar.bz2 |
Fix documentation for PyMarshal_WriteObjectToFile() and
PyMarshal_WriteObjectToFile().
This closes SF bug #533735.
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/api/utilities.tex | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Doc/api/utilities.tex b/Doc/api/utilities.tex index 96ff816..d60a79f 100644 --- a/Doc/api/utilities.tex +++ b/Doc/api/utilities.tex @@ -286,14 +286,14 @@ Numeric values are stored with the least significant byte first. \end{cfuncdesc} \begin{cfuncdesc}{void}{PyMarshal_WriteShortToFile}{short value, FILE *file} - Marshal a \ctype{short} integer, \var{value}, to \var{file}. + Marshal a \ctype{short} integer, \var{value}, to \var{file}. This + will only write the least-significant 16 bits of \var{value}; + regardless of the size of the native \ctype{short} type. \end{cfuncdesc} \begin{cfuncdesc}{void}{PyMarshal_WriteObjectToFile}{PyObject *value, FILE *file} - Marshal a Python object, \var{value}, to \var{file}. This - will only write the least-significant 16 bits of \var{value}; - regardless of the size of the native \ctype{short} type. + Marshal a Python object, \var{value}, to \var{file}. \end{cfuncdesc} \begin{cfuncdesc}{PyObject*}{PyMarshal_WriteObjectToString}{PyObject *value} @@ -318,7 +318,7 @@ Should only non-negative values be written using these routines? \begin{cfuncdesc}{int}{PyMarshal_ReadShortFromFile}{FILE *file} Return a C \ctype{short} from the data stream in a \ctype{FILE*} opened for reading. Only a 16-bit value can be read in using - this function, regardless of the native size of \ctype{long}. + this function, regardless of the native size of \ctype{short}. \end{cfuncdesc} \begin{cfuncdesc}{PyObject*}{PyMarshal_ReadObjectFromFile}{FILE *file} |