Skip to content

Commit e0a428d

Browse files
committed
gh-156866: Document that pack_into() does not guarantee memory access shape
1 parent 09117bc commit e0a428d

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

Doc/library/struct.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,13 @@ The module defines the following exception and functions:
7070
position *offset*. Note that *offset* is a required argument.
7171
A negative *offset* counts from the end of *buffer*.
7272

73+
.. note::
74+
75+
This function only specifies the packed bytes written to *buffer*; it
76+
does not guarantee the number, width, or ordering of the underlying
77+
memory accesses used to write them, including for buffers backed by
78+
memory-mapped I/O.
79+
7380

7481
.. function:: unpack(format, buffer)
7582

0 commit comments

Comments
 (0)