Author chris.jerdonek
Recipients chris.jerdonek, docs@python, eric.araujo, ezio.melotti, pitrou
Date 2012-11-21.06:03:27
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1353477807.87.0.204584648831.issue16518@psf.upfronthosting.co.za>
In-reply-to
Content
This issue is to add "buffer protocol" (or perhaps "buffer object") to the glossary.  The concept is currently described here:

http://docs.python.org/dev/c-api/buffer.html#buffer-protocol

Éric initially suggested doing this in the comments to issue 13538.

Such a glossary entry would be useful because the buffer protocol (or buffer object) should likely be cited, for example, wherever a function accepts a bytes object, bytearray object, or any object that supports the buffer protocol.  The str() constructor is one example where this is done:

http://hg.python.org/cpython/file/59acd5cac8b5/Doc/library/functions.rst#l1275

"Buffer object" might be the more useful term to add to the glossary because it would help to have a briefer way of saying "any object that supports the buffer protocol."  (I'm assuming this is what "buffer object" actually means.)

The patch for this issue should also do a comprehensive review of occurrences of buffer object/protocol throughout the docs and add or update links and index entries where appropriate.
History
Date User Action Args
2012-11-21 06:03:27chris.jerdoneksetrecipients: + chris.jerdonek, pitrou, ezio.melotti, eric.araujo, docs@python
2012-11-21 06:03:27chris.jerdoneksetmessageid: <1353477807.87.0.204584648831.issue16518@psf.upfronthosting.co.za>
2012-11-21 06:03:27chris.jerdoneklinkissue16518 messages
2012-11-21 06:03:27chris.jerdonekcreate