From: Fred Drake <fdrake@acm.org>
Date: Thu, 4 Apr 2002 04:10:36 +0000 (+0000)
Subject: Correct the descriptions of the PyObject_As*Buffer() return values.
X-Git-Tag: v2.3c1~6148
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=243ea7166913a6cf9852373b2a3d965d6587477b;p=python

Correct the descriptions of the PyObject_As*Buffer() return values.
This closes SF bug #539081.
---

diff --git a/Doc/api/abstract.tex b/Doc/api/abstract.tex
index 4d922685bd..07d659288b 100644
--- a/Doc/api/abstract.tex
+++ b/Doc/api/abstract.tex
@@ -895,9 +895,9 @@ else {
                                               int *buffer_len}
   Returns a pointer to a read-only memory location useable as character-
   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
-  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}
 \end{cfuncdesc}
 
@@ -907,8 +907,8 @@ else {
   Returns a pointer to a read-only memory location containing
   arbitrary data.  The \var{obj} argument must support the
   single-segment readable buffer interface.  On success, returns
-  \code{1}, sets \var{buffer} to the memory location and \var{buffer_len}
-  to the buffer length.  Returns \code{0} and sets a
+  \code{0}, sets \var{buffer} to the memory location and \var{buffer_len}
+  to the buffer length.  Returns \code{-1} and sets a
   \exception{TypeError} on error.
   \versionadded{1.6}
 \end{cfuncdesc}
@@ -924,8 +924,8 @@ else {
                                                int *buffer_len}
   Returns a pointer to a writeable memory location.  The \var{obj}
   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
-  \code{0} and sets a \exception{TypeError} on error.
+  \code{-1} and sets a \exception{TypeError} on error.
   \versionadded{1.6}
 \end{cfuncdesc}