summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Dickinson <dickinsm@gmail.com>2010-06-29 20:09:12 +0000
committerMark Dickinson <dickinsm@gmail.com>2010-06-29 20:09:12 +0000
commitd5087417f07dc027fd0832796f71fa60e11ea034 (patch)
tree5111d959c9fcf5d70a0d4a944e29f5551651c653
parente72b155eea4879d09d297bbb7db8071c4135297f (diff)
downloadcpython-d5087417f07dc027fd0832796f71fa60e11ea034.tar.gz
Issue #1789: clarify that the 'size' column in struct docs refers to standard size.
-rw-r--r--Doc/library/struct.rst6
1 files changed, 5 insertions, 1 deletions
diff --git a/Doc/library/struct.rst b/Doc/library/struct.rst
index f76e4a1309..b5fd43278f 100644
--- a/Doc/library/struct.rst
+++ b/Doc/library/struct.rst
@@ -156,7 +156,11 @@ Format Characters
^^^^^^^^^^^^^^^^^
Format characters have the following meaning; the conversion between C and
-Python values should be obvious given their types:
+Python values should be obvious given their types. The 'Standard size' column
+refers to the size of the packed value in bytes when using standard size; that
+is, when the format string starts with one of ``'<'``, ``'>'``, ``'!'`` or
+``'='``. When using native size, the size of the packed value is
+platform-dependent.
+--------+-------------------------+--------------------+----------------+------------+
| Format | C Type | Python type | Standard size | Notes |