Skip to content

Commit 83b3f67

Browse files
authored
Merge pull request #264 from jbms/simplify-transpose-options
Require transpose codec `order` option to be specified as an explicit permutation
2 parents 97453eb + f848fcf commit 83b3f67

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

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

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,9 @@ Configuration parameters
6161
========================
6262

6363
order:
64-
Required. Must be one of:
65-
66-
- An array of integers specifying a permutation of ``0``, ``1``, ...,
67-
``n-1``, where ``n`` is the number of dimensions in the decoded chunk
68-
representation provided as input to this codec.
69-
- The string ``"C"``, equivalent to specifying the identity permutation
70-
``0``, ``1``, ..., ``n-1``. This makes the codec a no-op.
71-
- The string ``"F"``, equivalent to specifying the permutation ``n-1``, ...,
72-
``1``, ``0``.
64+
Required. Must be an array of integers specifying a permutation of ``0``, ``1``, ...,
65+
`n-1``, where ``n`` is the number of dimensions in the decoded chunk
66+
representation provided as input to this codec.
7367

7468
Format and algorithm
7569
====================
@@ -101,4 +95,8 @@ References
10195
Change log
10296
==========
10397

104-
No changes yet.
98+
Changes after acceptance of ZEP 1
99+
---------------------------------
100+
101+
The ``order`` configuration parameter no longer supports the constants ``"C"``
102+
or ``"F"`` and must instead always be specified as an explicit permutation.

0 commit comments

Comments
 (0)