From b084017c7a27ab37ef6918aaf7e0f665c0dbe2ed Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Mon, 17 Jun 2002 15:44:18 +0000 Subject: [PATCH] Fix documentation for PyMarshal_WriteObjectToFile() and PyMarshal_WriteObjectToFile(). This closes SF bug #533735. --- Doc/api/utilities.tex | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Doc/api/utilities.tex b/Doc/api/utilities.tex index 96ff8162d3..d60a79f95b 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} -- 2.40.0