]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[doc] struct: update note about network byte order form to be more helpful (GH-22201)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 11 Sep 2020 15:29:04 +0000 (08:29 -0700)
committerGitHub <noreply@github.com>
Fri, 11 Sep 2020 15:29:04 +0000 (08:29 -0700)
Update the sentence to provide some context on why network byte order is defined as big endian.
(cherry picked from commit fb2718720346c8c7a0ad2d7477f20e9a5524ea0c)

Co-authored-by: Stargirl Flowers <theaflowers@google.com>
Doc/library/struct.rst

index 56b0a3614df5332da247fe6f77a0bdc9dec7bc3a..278cb19f5b472651a4f2198b9b10b476cda82c26 100644 (file)
@@ -159,8 +159,8 @@ the :ref:`format-characters` section.
 Note the difference between ``'@'`` and ``'='``: both use native byte order, but
 the size and alignment of the latter is standardized.
 
-The form ``'!'`` is available for those poor souls who claim they can't remember
-whether network byte order is big-endian or little-endian.
+The form ``'!'`` represents the network byte order which is always big-endian
+as defined in `IETF RFC 1700 <IETF RFC 1700_>`_.
 
 There is no way to indicate non-native byte order (force byte-swapping); use the
 appropriate choice of ``'<'`` or ``'>'``.
@@ -467,3 +467,5 @@ The :mod:`struct` module also defines the following type:
 .. _half precision format: https://en.wikipedia.org/wiki/Half-precision_floating-point_format
 
 .. _ieee 754 standard: https://en.wikipedia.org/wiki/IEEE_floating_point#IEEE_754-2008
+
+.. _IETF RFC 1700: https://tools.ietf.org/html/rfc1700