Skip to content

Commit b646e1b

Browse files
clarify shuffling
Co-authored-by: David Brochart <[email protected]>
1 parent 571cbc0 commit b646e1b

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/codecs.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,10 +135,12 @@ clevel:
135135
level is 0.
136136

137137
shuffle:
138-
An integer value in the set {0, 1, 2, -1}. A value of 1
139-
indicates that byte-wise shuffling is performed in addition to
138+
An integer value in the set {0, 1, 2, -1} indicating the way
139+
bytes or bits are rearranged, which can lead to faster
140+
and/or greater compression. A value of 1
141+
indicates that byte-wise shuffling is performed prior to
140142
compression. A value of 2 indicates the bit-wise shuffling is
141-
performed in addition to compression. If a value of -1 is given,
143+
performed prior to compression. If a value of -1 is given,
142144
then default shuffling is used: bit-wise shuffling for buffers
143145
with item size of 1 byte, byte-wise shuffling otherwise.
144146
Shuffling is turned off completely when the value is 0.

0 commit comments

Comments
 (0)