This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: PyObject_AsReadBuffer doc error
Type: Stage:
Components: Documentation Versions: Python 2.2
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: fdrake Nosy List: fdrake, madcow42
Priority: normal Keywords:

Created on 2002-04-04 03:53 by madcow42, last changed 2022-04-10 16:05 by admin. This issue is now closed.

Messages (2)
msg10147 - (view) Author: Kevin Cazabon (madcow42) Date: 2002-04-04 03:53
The documentation for PyObject_AsReadBuffer (and 
others in that group, I suspect) seems to be incorrect.

It notes that PyObject_AsReadBuffer returns 1 on 
success, 0 on failure.  However, it returns 0 on 
success and -1 on failure.  

This is true for the current documentation on 
Python.org, as well as older versions.

Thanks!

(or, this could be treated as a bug in 
PyObject_AsReadBuffer itself, returning the wrong 
values... which is probably more accurate, so it is 
consistent with other functions in the C API.  
However, changing it's return value at this point 
would break a LOT of software)
msg10148 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2002-04-04 04:23
Logged In: YES 
user_id=3066

Fixed in Doc/api/abstract.tex revisions 1.11 and 1.8.6.3. 
Added the relevant PyObject_As*Buffer() descriptions to
Doc/api/api.tex revision 1.117.2.13 (for Python 2.1.3) as
well, since I'm making changes for these functions anyway.
History
Date User Action Args
2022-04-10 16:05:11adminsetgithub: 36378
2002-04-04 03:53:27madcow42create