Skip to content

Commit 58fdacb

Browse files
authored
Merge pull request #235 from rouault/fix_232
V3 spec: add a 'codec name' paragraph in each codec specification (fixes #232)
2 parents 7b327ce + be744f7 commit 58fdacb

File tree

5 files changed

+30
-0
lines changed

5 files changed

+30
-0
lines changed

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,12 @@ explicitly marked as non-normative, examples, and notes. Examples in
5252
this specification are introduced with the words "for example".
5353

5454

55+
Codec name
56+
==========
57+
58+
The value of the ``name`` member in the codec object MUST be ``blosc``.
59+
60+
5561
Configuration parameters
5662
========================
5763

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,12 @@ explicitly marked as non-normative, examples, and notes. Examples in
5555
this specification are introduced with the words "for example".
5656

5757

58+
Codec name
59+
==========
60+
61+
The value of the ``name`` member in the codec object MUST be ``endian``.
62+
63+
5864
Configuration parameters
5965
========================
6066

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,12 @@ explicitly marked as non-normative, examples, and notes. Examples in
5252
this specification are introduced with the words "for example".
5353

5454

55+
Codec name
56+
==========
57+
58+
The value of the ``name`` member in the codec object MUST be ``gzip``.
59+
60+
5561
Configuration parameters
5662
========================
5763

docs/v3/codecs/sharding-indexed/v1.0.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,12 @@ marked as non-normative, examples, and notes. Examples in this specification are
7373
introduced with the words "for example".
7474

7575

76+
Codec name
77+
==========
78+
79+
The value of the ``name`` member in the codec object MUST be ``sharding_indexed``.
80+
81+
7682
Configuration parameters
7783
========================
7884

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,12 @@ explicitly marked as non-normative, examples, and notes. Examples in
5555
this specification are introduced with the words "for example".
5656

5757

58+
Codec name
59+
==========
60+
61+
The value of the ``name`` member in the codec object MUST be ``transpose``.
62+
63+
5864
Configuration parameters
5965
========================
6066

0 commit comments

Comments
 (0)