diff options
| author | Martin Panter <vadmium+py@gmail.com> | 2016-04-15 23:03:54 (GMT) | 
|---|---|---|
| committer | Martin Panter <vadmium+py@gmail.com> | 2016-04-15 23:03:54 (GMT) | 
| commit | b030991a5ff560e195d2010b48eed14d59b679fa (patch) | |
| tree | d7c6aa70d20197507f63a7d34a53615d3a088ded /Modules/_struct.c | |
| parent | abf797df66c4c87e508a4a2fd71e3cb19a8624ac (diff) | |
| download | cpython-b030991a5ff560e195d2010b48eed14d59b679fa.zip cpython-b030991a5ff560e195d2010b48eed14d59b679fa.tar.gz cpython-b030991a5ff560e195d2010b48eed14d59b679fa.tar.bz2  | |
Issue #26535: Correct docs regarding the struct buffer size
Diffstat (limited to 'Modules/_struct.c')
| -rw-r--r-- | Modules/_struct.c | 16 | 
1 files changed, 8 insertions, 8 deletions
diff --git a/Modules/_struct.c b/Modules/_struct.c index ffedb9f..f965541 100644 --- a/Modules/_struct.c +++ b/Modules/_struct.c @@ -1497,8 +1497,8 @@ PyDoc_STRVAR(s_unpack__doc__,  "S.unpack(buffer) -> (v1, v2, ...)\n\  \n\  Return a tuple containing values unpacked according to the format\n\ -string S.format.  Requires len(buffer) == S.size.  See help(struct)\n\ -for more on format strings."); +string S.format.  The buffer's size in bytes must be S.size.  See\n\ +help(struct) for more on format strings.");  static PyObject *  s_unpack(PyObject *self, PyObject *input) @@ -1527,8 +1527,8 @@ PyDoc_STRVAR(s_unpack_from__doc__,  "S.unpack_from(buffer, offset=0) -> (v1, v2, ...)\n\  \n\  Return a tuple containing values unpacked according to the format\n\ -string S.format.  Requires len(buffer[offset:]) >= S.size.  See\n\ -help(struct) for more on format strings."); +string S.format.  The buffer's size in bytes, minus offset, must be at\n\ +least S.size.  See help(struct) for more on format strings.");  static PyObject *  s_unpack_from(PyObject *self, PyObject *args, PyObject *kwds) @@ -2130,8 +2130,8 @@ PyDoc_STRVAR(unpack_doc,  "unpack(fmt, buffer) -> (v1, v2, ...)\n\  \n\  Return a tuple containing values unpacked according to the format string\n\ -fmt.  Requires len(buffer) == calcsize(fmt). See help(struct) for more\n\ -on format strings."); +fmt.  The buffer's size in bytes must be calcsize(fmt). See help(struct)\n\ +for more on format strings.");  static PyObject *  unpack(PyObject *self, PyObject *args) @@ -2153,8 +2153,8 @@ PyDoc_STRVAR(unpack_from_doc,  "unpack_from(fmt, buffer, offset=0) -> (v1, v2, ...)\n\  \n\  Return a tuple containing values unpacked according to the format string\n\ -fmt.  Requires len(buffer[offset:]) >= calcsize(fmt).  See help(struct)\n\ -for more on format strings."); +fmt.  The buffer's size, minus offset, must be at least calcsize(fmt).\n\ +See help(struct) for more on format strings.");  static PyObject *  unpack_from(PyObject *self, PyObject *args, PyObject *kwds)  | 
