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: Buffer Protocol Documentation Error
Type: Stage: resolved
Components: Documentation Versions: Python 3.3, Python 3.4, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Jake.Vanderplas, docs@python, jcea, python-dev
Priority: normal Keywords: patch

Created on 2014-05-05 18:28 by Jake.Vanderplas, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
bufferdoc.patch Jake.Vanderplas, 2014-05-05 18:28 documentation patch review
Messages (3)
msg217939 - (view) Author: Jake Vanderplas (Jake.Vanderplas) * Date: 2014-05-05 18:28
The ``obj`` and ``buf`` structure elements are switched in the documentation of the Buffer Protocol.

Compare https://docs.python.org/3.3/c-api/buffer.html#Py_buffer to https://github.com/python/cpython/blob/master/Include/object.h#L179-180
msg221519 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2014-06-25 03:39
New changeset 92d691c3ca00 by Jesus Cea in branch '3.3':
Closes #21441: Reorder elements in documentation to match actual order in the code
http://hg.python.org/cpython/rev/92d691c3ca00

New changeset d9da4b77624b by Jesus Cea in branch '3.4':
MERGE: Closes #21441: Reorder elements in documentation to match actual order in the code
http://hg.python.org/cpython/rev/d9da4b77624b

New changeset 5e6c4070a785 by Jesus Cea in branch 'default':
MERGE: Closes #21441: Reorder elements in documentation to match actual order in the code
http://hg.python.org/cpython/rev/5e6c4070a785
msg221520 - (view) Author: Jesús Cea Avión (jcea) * (Python committer) Date: 2014-06-25 03:39
Thanks, Jake.
History
Date User Action Args
2022-04-11 14:58:03adminsetgithub: 65640
2014-06-25 03:39:59jceasetnosy: + jcea
messages: + msg221520
2014-06-25 03:39:05python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg221519

resolution: fixed
stage: resolved
2014-05-05 18:28:03Jake.Vanderplascreate