mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-02 16:13:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Correct the descriptions of the PyObject_As*Buffer() return values.

Browse source 
This closes SF bug #539081.
This commit is contained in:
Fred Drake 2002-04-04 04:10:36 +00:00
parent 645a22e007
commit 243ea71669
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
Doc/api/abstract.tex
View file

@ -895,9 +895,9 @@ else {
int *buffer_len} int *buffer_len}
Returns a pointer to a read-only memory location useable as character- Returns a pointer to a read-only memory location useable as character-
based input. The \var{obj} argument must support the single-segment based input. The \var{obj} argument must support the single-segment
character buffer interface. On success, returns \code{1}, sets character buffer interface. On success, returns \code{0}, sets
\var{buffer} to the memory location and \var{buffer_len} to the buffer \var{buffer} to the memory location and \var{buffer_len} to the buffer
length. Returns \code{0} and sets a \exception{TypeError} on error. length. Returns \code{-1} and sets a \exception{TypeError} on error.
\versionadded{1.6} \versionadded{1.6}
\end{cfuncdesc} \end{cfuncdesc}
@ -907,8 +907,8 @@ else {
Returns a pointer to a read-only memory location containing Returns a pointer to a read-only memory location containing
arbitrary data. The \var{obj} argument must support the arbitrary data. The \var{obj} argument must support the
single-segment readable buffer interface. On success, returns single-segment readable buffer interface. On success, returns
\code{1}, sets \var{buffer} to the memory location and \var{buffer_len} \code{0}, sets \var{buffer} to the memory location and \var{buffer_len}
to the buffer length. Returns \code{0} and sets a to the buffer length. Returns \code{-1} and sets a
\exception{TypeError} on error. \exception{TypeError} on error.
\versionadded{1.6} \versionadded{1.6}
\end{cfuncdesc} \end{cfuncdesc}
@ -924,8 +924,8 @@ else {
int *buffer_len} int *buffer_len}
Returns a pointer to a writeable memory location. The \var{obj} Returns a pointer to a writeable memory location. The \var{obj}
argument must support the single-segment, character buffer argument must support the single-segment, character buffer
interface. On success, returns \code{1}, sets \var{buffer} to the interface. On success, returns \code{0}, sets \var{buffer} to the
memory location and \var{buffer_len} to the buffer length. Returns memory location and \var{buffer_len} to the buffer length. Returns
\code{0} and sets a \exception{TypeError} on error. \code{-1} and sets a \exception{TypeError} on error.
\versionadded{1.6} \versionadded{1.6}
\end{cfuncdesc} \end{cfuncdesc}