[issue16518] add "buffer protocol" to glossary
New submission from Chris Jerdonek:
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#l12...
"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.
----------
assignee: docs@python
components: Documentation
messages: 176042
nosy: chris.jerdonek, docs@python, eric.araujo, ezio.melotti, pitrou
priority: normal
severity: normal
status: open
title: add "buffer protocol" to glossary
type: enhancement
versions: Python 3.2, Python 3.3, Python 3.4
_______________________________________
Python tracker
participants (11)
-
Antoine Pitrou
-
Chris Jerdonek
-
Ezio Melotti
-
Florent Xicluna
-
Georg Brandl
-
R. David Murray
-
Raymond Hettinger
-
Roundup Robot
-
Serhiy Storchaka
-
Stefan Krah
-
Terry J. Reedy