incorrect signature in doc for PyByteArray_Resize

[drukker]

BPO	6881
Nosy	@birkenfeld, @ezio-melotti

^{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/ezio-melotti'
closed_at = <Date 2009-09-20.07:24:44.568>
created_at = <Date 2009-09-11.09:24:43.008>
labels = ['docs']
title = 'incorrect signature in doc for PyByteArray_Resize'
updated_at = <Date 2009-09-20.07:24:44.567>
user = 'https://bugs.python.org/drukker'

bugs.python.org fields:

activity = <Date 2009-09-20.07:24:44.567>
actor = 'ezio.melotti'
assignee = 'ezio.melotti'
closed = True
closed_date = <Date 2009-09-20.07:24:44.568>
closer = 'ezio.melotti'
components = ['Documentation']
creation = <Date 2009-09-11.09:24:43.008>
creator = 'drukker'
dependencies = []
files = []
hgrepos = []
issue_num = 6881
keywords = []
message_count = 4.0
messages = ['92506', '92661', '92672', '92882']
nosy_count = 3.0
nosy_names = ['georg.brandl', 'ezio.melotti', 'drukker']
pr_nums = []
priority = 'low'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue6881'
versions = ['Python 3.1', 'Python 2.7']

[drukker]

in Doc/c-api/bytearray.rst:

    PyObject* PyByteArray_Resize(PyObject *bytearray, Py_ssize_t len)

should be:

    int PyByteArray_Resize(PyObject *bytearray, Py_ssize_t len)

as per Include/bytearrayobject.h

[ezio-melotti]

The PyByteArrayIter_Type is also missing, and the arg names of several
functions don't match the ones in the C source in Objects/bytesobject.c .
It might also be a good idea to add sub-headers in the doc to group
these functions in the same way they are grouped in the .h file (i.e.
Type Object, Type check macros, Direct API functions, Macros).

[birkenfeld]

I don't think the iterator type needs to be documented; many other such
iter types aren't.

Also, the argument names needn't match (since C doesn't have the notion
of keyword arguments). They can be changed in the docs to be more
obvious than what the programmer chose :)

Would you like to fix the rest?

[ezio-melotti]

Fixed in r74958 (trunk), r74959 (release26-maint), r74960 (py3k) and
r74961 (release31-maint).