[Python-checkins] r82379 - python/trunk/Doc/library/struct.rst

[mark.dickinson]

Author: mark.dickinson
Date: Tue Jun 29 22:09:12 2010
New Revision: 82379

Log:
Issue #1789:  clarify that the 'size' column in struct docs refers to standard size.

Modified:
   python/trunk/Doc/library/struct.rst

Modified: python/trunk/Doc/library/struct.rst
==============================================================================
--- python/trunk/Doc/library/struct.rst	(original)
+++ python/trunk/Doc/library/struct.rst	Tue Jun 29 22:09:12 2010
@@ -156,7 +156,11 @@
 ^^^^^^^^^^^^^^^^^
 
 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      |