Skip to content

Commit 0794d91

Browse files
committed
clarification on endian attribute
1 parent 08eabab commit 0794d91

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/v3/codecs/bytes/v1.0.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,11 @@ Configuration parameters
6262
========================
6363

6464
endian:
65-
Required for multi-byte data types. A string equal to either ``"big"`` or ``"little"``.
65+
Required for data types for which endianness is applicable. For example,
66+
this includes multi-byte data types, such as ``uint16`` and ``int32``,
67+
but not single-byte data types, such as ``uint8`` or ``bool``.
68+
If present, the value MUST be a string equal to either ``"big"`` or
69+
``"little"``.
6670

6771

6872
Format and algorithm

0 commit comments

Comments
 (0)