Skip to content

Commit 2bb9f79

Browse files
committed
add refs
1 parent 6748354 commit 2bb9f79

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

docs/spec/v2.rst

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ Status
1515
This specification is the latest version. See :ref:`spec` for previous
1616
versions.
1717

18+
.. _spec_v2_storage:
19+
1820
Storage
1921
-------
2022

@@ -32,9 +34,13 @@ resources can be read, written or deleted via HTTP.
3234

3335
Below an "array store" refers to any system implementing this interface.
3436

37+
.. _spec_v2_array:
38+
3539
Arrays
3640
------
3741

42+
.. _spec_v2_array_metadata:
43+
3844
Metadata
3945
~~~~~~~~
4046

@@ -105,6 +111,8 @@ using the Blosc compression library prior to storage::
105111
"zarr_format": 2
106112
}
107113

114+
.. _spec_v2_array_dtype:
115+
108116
Data type encoding
109117
~~~~~~~~~~~~~~~~~~
110118

@@ -139,6 +147,8 @@ example, the JSON list ``[["r", "|u1"], ["g", "|u1"], ["b", "|u1"]]`` defines a
139147
data type composed of three single-byte unsigned integers labelled "r", "g" and
140148
"b".
141149

150+
.. _spec_v2_array_fill_value:
151+
142152
Fill value encoding
143153
~~~~~~~~~~~~~~~~~~~
144154

@@ -157,6 +167,8 @@ If an array has a fixed length byte string data type (e.g., ``"|S12"``), or a
157167
structured data type, and if the fill value is not null, then the fill value
158168
MUST be encoded as an ASCII string using the standard Base64 alphabet.
159169

170+
.. _spec_v2_array_chunks:
171+
160172
Chunks
161173
~~~~~~
162174

@@ -190,6 +202,8 @@ array dimension is not exactly divisible by the length of the corresponding
190202
chunk dimension then some chunks will overhang the edge of the array. The
191203
contents of any chunk region falling outside the array are undefined.
192204

205+
.. _spec_v2_array_filters:
206+
193207
Filters
194208
~~~~~~~
195209

@@ -200,9 +214,13 @@ the primary compressor. When retrieving data, stored chunk data are
200214
decompressed by the primary compressor then decoded using filters in the
201215
reverse order.
202216

217+
.. _spec_v2_hierarchy:
218+
203219
Hierarchies
204220
-----------
205221

222+
.. _spec_v2_hierarchy_paths:
223+
206224
Logical storage paths
207225
~~~~~~~~~~~~~~~~~~~~~
208226

@@ -238,6 +256,8 @@ treat all keys as opaque ASCII strings; equally, an array store could map
238256
logical paths onto some kind of hierarchical storage (e.g., directories on a
239257
file system).
240258

259+
.. _spec_v2_hierarchy_groups:
260+
241261
Groups
242262
~~~~~~
243263

@@ -272,6 +292,8 @@ under the logical paths "foo" and "foo/bar" and an array exists at logical path
272292
"foo/baz" then the members of the group at path "foo" are the group at path
273293
"foo/bar" and the array at path "foo/baz".
274294

295+
.. _spec_v2_attrs:
296+
275297
Attributes
276298
----------
277299

@@ -290,6 +312,8 @@ For example, the JSON object below encodes three attributes named
290312
"baz": [1, 2, 3, 4]
291313
}
292314

315+
.. _spec_v2_examples:
316+
293317
Examples
294318
--------
295319

@@ -466,6 +490,8 @@ What has been stored::
466490
foo/bar/1.0
467491
foo/bar/1.1
468492

493+
.. _spec_v2_changes:
494+
469495
Changes
470496
-------
471497

@@ -487,8 +513,8 @@ initially published to clarify ambiguities and add some missing information.
487513
empty.
488514

489515

490-
Changes in version 2
491-
~~~~~~~~~~~~~~~~~~~~
516+
Changes from version 1 to version 2
517+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
492518

493519
The following changes were made between version 1 and version 2 of this specification:
494520

0 commit comments

Comments
 (0)