PyObject_AsReadBuffer doc error

[madcow42]

BPO	539081
Nosy	@freddrake

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/freddrake'
closed_at = <Date 2002-04-04.04:23:00.000>
created_at = <Date 2002-04-04.03:53:27.000>
labels = ['docs']
title = 'PyObject_AsReadBuffer doc error'
updated_at = <Date 2002-04-04.04:23:00.000>
user = 'https://bugs.python.org/madcow42'

bugs.python.org fields:

activity = <Date 2002-04-04.04:23:00.000>
actor = 'fdrake'
assignee = 'fdrake'
closed = True
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2002-04-04.03:53:27.000>
creator = 'madcow42'
dependencies = []
files = []
hgrepos = []
issue_num = 539081
keywords = []
message_count = 2.0
messages = ['10147', '10148']
nosy_count = 2.0
nosy_names = ['fdrake', 'madcow42']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue539081'
versions = ['Python 2.2']

[madcow42]

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)

[freddrake]

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.