Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Fix documentation for PyMarshal_WriteObjectToFile() and 

PyMarshal_WriteObjectToFile().
This closes SF bug #533735.
This commit is contained in:
Fred Drake 2002-06-17 15:44:18 +00:00
parent 6fc22f6c3d
commit b084017c7a
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Doc/api/utilities.tex
View File

@ -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}