Fix closes Issue11436 - Minor clarification to struct documentation for 's' format character.

This commit is contained in:
Senthil Kumaran 2011-07-17 17:29:17 +08:00
parent 0b447957c7
commit ad3882a2b0

View file

@ -240,10 +240,11 @@ not contain whitespace though.
For the ``'s'`` format character, the count is interpreted as the length of the For the ``'s'`` format character, the count is interpreted as the length of the
bytes, not a repeat count like for the other format characters; for example, bytes, not a repeat count like for the other format characters; for example,
``'10s'`` means a single 10-byte string, while ``'10c'`` means 10 characters. ``'10s'`` means a single 10-byte string, while ``'10c'`` means 10 characters.
For packing, the string is truncated or padded with null bytes as appropriate to If a count is not given, it defaults to 1. For packing, the string is
make it fit. For unpacking, the resulting bytes object always has exactly the truncated or padded with null bytes as appropriate to make it fit. For
specified number of bytes. As a special case, ``'0s'`` means a single, empty unpacking, the resulting bytes object always has exactly the specified number
string (while ``'0c'`` means 0 characters). of bytes. As a special case, ``'0s'`` means a single, empty string (while
``'0c'`` means 0 characters).
When packing a value ``x`` using one of the integer formats (``'b'``, When packing a value ``x`` using one of the integer formats (``'b'``,
``'B'``, ``'h'``, ``'H'``, ``'i'``, ``'I'``, ``'l'``, ``'L'``, ``'B'``, ``'h'``, ``'H'``, ``'i'``, ``'I'``, ``'l'``, ``'L'``,