mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-04 03:44:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Fix documentation for PyMarshal_WriteObjectToFile() and

Browse source 
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
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} \end{cfuncdesc}
\begin{cfuncdesc}{void}{PyMarshal_WriteShortToFile}{short value, FILE *file} \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} \end{cfuncdesc}
\begin{cfuncdesc}{void}{PyMarshal_WriteObjectToFile}{PyObject *value, \begin{cfuncdesc}{void}{PyMarshal_WriteObjectToFile}{PyObject *value,
FILE *file} FILE *file}
Marshal a Python object, \var{value}, to \var{file}. This Marshal a Python object, \var{value}, to \var{file}.
will only write the least-significant 16 bits of \var{value};
regardless of the size of the native \ctype{short} type.
\end{cfuncdesc} \end{cfuncdesc}
\begin{cfuncdesc}{PyObject*}{PyMarshal_WriteObjectToString}{PyObject *value} \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} \begin{cfuncdesc}{int}{PyMarshal_ReadShortFromFile}{FILE *file}
Return a C \ctype{short} from the data stream in a \ctype{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 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} \end{cfuncdesc}
\begin{cfuncdesc}{PyObject*}{PyMarshal_ReadObjectFromFile}{FILE *file} \begin{cfuncdesc}{PyObject*}{PyMarshal_ReadObjectFromFile}{FILE *file}