[New-bugs-announce] [issue7696] Improve Memoryview/Buffer documentation

Florent Xicluna report at bugs.python.org
Wed Jan 13 22:33:51 CET 2010


New submission from Florent Xicluna <laxyf at yahoo.fr>:

Various notes while reading the Memoryview documentation:

 - “memoryviews allow Python code to access the internal data of an object that supports the buffer protocol without copying. Memory can be interpreted as simple bytes or complex data structures.” This is quite obscure because there's no definition of the "buffer protocol".

 - a link from 6.10 to the c-api/buffer.html page may be useful

 - the memoryview.suboffsets attribute is not documented on the "6.10 memoryview Type" page

 - there's no glossary entry for the "buffer protocol" (does it deserve an entry?)

 - "Memoryview" is title-cased in one case (c-api/buffer.html) but lowercased for the title of section 6.10 (stdtypes.html#memoryview-types)

----------
assignee: georg.brandl
components: Documentation
messages: 97738
nosy: flox, georg.brandl
severity: normal
status: open
title: Improve Memoryview/Buffer documentation
versions: Python 2.7, Python 3.1, Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue7696>
_______________________________________


More information about the New-bugs-announce mailing list