summaryrefslogtreecommitdiffstats
path: root/Doc/c-api/arg.rst
diff options
context:
space:
mode:
authorAntoine Pitrou <solipsis@pitrou.net>2011-01-06 07:16:31 (GMT)
committerAntoine Pitrou <solipsis@pitrou.net>2011-01-06 07:16:31 (GMT)
commitd53dfa3fb1c86e97ad787bdcb3c7e068a7ba2580 (patch)
tree99f69000135462b88b87938ed9ca9dcc3fa9bfa8 /Doc/c-api/arg.rst
parent7beae8a0d567022f959c70f0be367ced7af65808 (diff)
downloadcpython-d53dfa3fb1c86e97ad787bdcb3c7e068a7ba2580.zip
cpython-d53dfa3fb1c86e97ad787bdcb3c7e068a7ba2580.tar.gz
cpython-d53dfa3fb1c86e97ad787bdcb3c7e068a7ba2580.tar.bz2
Issue #10840: make it explicit that "s*" and friends provide contiguous memory.
Diffstat (limited to 'Doc/c-api/arg.rst')
-rw-r--r--Doc/c-api/arg.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/c-api/arg.rst b/Doc/c-api/arg.rst
index a32dd09..d4dda7c 100644
--- a/Doc/c-api/arg.rst
+++ b/Doc/c-api/arg.rst
@@ -30,9 +30,10 @@ variable(s) whose address should be passed.
Strings and buffers
-------------------
-These formats do not expect you to provide raw storage for the returned string
-or bytes. Also, you won't have to release any memory yourself, except with
-the ``es``, ``es#``, ``et`` and ``et#`` formats.
+These formats allow to access an object as a contiguous chunk of memory.
+You don't have to provide raw storage for the returned unicode or bytes
+area. Also, you won't have to release any memory yourself, except with the
+``es``, ``es#``, ``et`` and ``et#`` formats.
However, when a :c:type:`Py_buffer` structure gets filled, the underlying
buffer is locked so that the caller can subsequently use the buffer even