Skip to content

Commit 836a880

Browse files
committed
links
1 parent faa1bd8 commit 836a880

File tree

2 files changed

+8
-9
lines changed

2 files changed

+8
-9
lines changed

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,8 @@ introduced with the words "for example".
7777
Configuration parameters
7878
========================
7979

80-
Sharding can be configured per array in the :ref:`array-metadata` as follows:
80+
Sharding can be configured per array in the :ref:`array-metadata` as follows::
8181

82-
.. code-block::
8382
{
8483
codecs: [
8584
{
@@ -129,12 +128,12 @@ referencing them. The index is placed at the end of the file and has a size of
129128
``16 bytes * 4 = 1024 bytes`` for shard shape of ``[64, 64]`` and inner chunk
130129
shape of ``[32, 32]``. The index holds an `offset, nbytes` pair of little-endian
131130
uint64 per chunk, the chunks-order in the index is row-major (C) order. Given
132-
the example of 2x2 inner chunks in a shard, the index would look like:
131+
the example of 2x2 inner chunks in a shard, the index would look like::
133132

134-
.. code-block::
135133
| chunk (0, 0) | chunk (0, 1) | chunk (1, 0) | chunk (1, 1) |
136134
| offset | nbytes | offset | nbytes | offset | nbytes | offset | nbytes |
137135
| uint64 | uint64 | uint64 | uint64 | uint64 | uint64 | uint64 | uint64 |
136+
138137
Empty chunks are denoted by setting both offset and nbytes to ``2^64 - 1``.
139138
Empty chunks are interpreted as being filled with the fill value. The index
140139
always has the full shape of all possible chunks per shard, even if they extend
@@ -177,7 +176,7 @@ common optimizations.
177176
relevant bytes that belong to the requested chunk. The relevant bytes are
178177
determined by the `offset,nbytes` pair in the shard index. This bytestream
179178
then needs to be decoded with the inner codecs as specified in the sharding
180-
configuration applying the :ref:`_decoding_procedure`. This is similar to how
179+
configuration applying the :ref:`decoding_procedure`. This is similar to how
181180
an implementation would access a sub-slice of a chunk.
182181

183182
When reading all chunks of a shard at once, a useful optimization would be to
@@ -192,7 +191,7 @@ common optimizations.
192191
bytestream, then, needs to be decoded as above.
193192

194193
* **Encoding**: A simple implementation to encode a chunk in a shard would (a)
195-
encode the new chunk per :ref:`_encoding_procedure` in a byte buffer using the
194+
encode the new chunk per :ref:`encoding_procedure` in a byte buffer using the
196195
shard's inner codecs, (b) read an existing shard from the store, (c) create a
197196
new bytestream with all encoded chunks of that shard including the overwritten
198197
chunk, (d) generate a new shard index that is appended to the chunk bytestream

docs/v3/core/v3.0.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -348,9 +348,9 @@ The following figure illustrates the first part of the terminology:
348348
storage transformers may intercept and alter the storage keys and bytes
349349
of an array_ before they reach the underlying physical storage.
350350
Upon retrieval, the original keys and bytes are restored within the
351-
transformer. Any number of `predefined storage transformers`_ can be
352-
registered and stacked. In contrast to codecs, storage transformers can
353-
act on the a complete array, rather than individual chunks. See the
351+
transformer. Any number of storage transformers can be registered and
352+
stacked. In contrast to codecs, storage transformers can act on the a
353+
complete array, rather than individual chunks. See the
354354
`storage transformers details`_ below.
355355

356356
.. _`storage transformers details`: #storage-transformers-1

0 commit comments

Comments
 (0)