Skip to content

Commit d2d6c39

Browse files
authored
DOC: Remove "current" from byte-order note and expand it slightly (numpy#22521)
We don't preserve non-native byte-order and we have no wish to do so. (If someone disagrees, they better wite a NEP ;)) Spell it out, and thus: closes numpygh-1866 Co-authored-by: Sebastian Berg <[email protected]>
1 parent 7772888 commit d2d6c39

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

doc/source/user/byteswapping.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,15 @@ is also big-endian). However, sometimes you need to flip these around.
6161

6262
.. warning::
6363

64-
Scalars currently do not include byte order information, so extracting
65-
a scalar from an array will return an integer in native byte order.
66-
Hence:
64+
Scalars do not include byte order information, so extracting a scalar from
65+
an array will return an integer in native byte order. Hence:
6766

6867
>>> big_end_arr[0].dtype.byteorder == little_end_u4[0].dtype.byteorder
6968
True
7069

70+
NumPy intentionally does not attempt to always preserve byte-order
71+
and for example converts to native byte-order in `numpy.concatenate`.
72+
7173
Changing byte ordering
7274
======================
7375

0 commit comments

Comments
 (0)