Skip to content

Commit 4990470

Browse files
authored
Merge pull request #272 from d-v-b/style_2
style tweaks
2 parents 6c057ae + 87bc65b commit 4990470

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

docs/v3/core/v3.0.rst

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ This core specification adheres to a ``MAJOR.MINOR`` version
116116
number format. When incrementing the minor version, only additional features
117117
can be added. Breaking changes require incrementing the major version.
118118

119-
A zarr implementation that provides the read and write API by
119+
A Zarr implementation that provides the read and write API by
120120
implementing a specification ``X.Y`` can be considered compatible with all
121121
datasets which only use features contained in version ``X.Y``.
122122

@@ -321,7 +321,7 @@ The following figure illustrates the first part of the terminology:
321321
hierarchy_ are held in a store as raw bytes. To enable a variety
322322
of different store types to be used, this specification defines an
323323
`Abstract store interface`_ which is a common set of operations that stores
324-
may provide. For example, a directory in a file system can be a zarr store,
324+
may provide. For example, a directory in a file system can be a Zarr store,
325325
where keys are file names, values are file contents, and files can be read,
326326
written, listed or deleted via the operating system. Equally, an S3 bucket
327327
can provide this interface, where keys are resource names, values are
@@ -678,18 +678,18 @@ The following members are optional:
678678
unnamed dimension is indicated by the null object. If ``dimension_names`` is
679679
not specified, all dimensions are unnamed.
680680

681-
For compatibility with zarr implementations and applications that support
681+
For compatibility with Zarr implementations and applications that support
682682
using dimension names to uniquely identify dimensions, it is recommended but
683683
not required that all non-null dimension names are distinct (no two
684684
dimensions have the same non-empty name).
685685

686686
This specification also does not place any restrictions on the use of the
687-
same dimension name across multiple arrays within the same zarr hierarchy,
687+
same dimension name across multiple arrays within the same Zarr hierarchy,
688688
but extensions or specific applications may do so.
689689

690690
The array metadata object must not contain any other names.
691691
Those are reserved for future versions of this specification.
692-
An implementation must fail to open zarr hierarchies, groups
692+
An implementation must fail to open Zarr hierarchies, groups
693693
or arrays with unknown metadata fields, with the exception of
694694
objects with a ``"must_understand": false`` key-value pair.
695695

@@ -769,7 +769,7 @@ above, but using a (currently made up) extension data type::
769769

770770
.. note::
771771

772-
Comparison with zarr spec v2:
772+
Comparison with Zarr spec v2:
773773

774774
- ``dtype`` has been renamed to ``data_type``,
775775
- ``chunks`` has been replaced with ``chunk_grid``,
@@ -873,7 +873,7 @@ This follows the
873873
representation is the ``UTF-8`` encoded Unicode string.
874874

875875
.. note::
876-
The prefix ``__zarr`` is reserved for core zarr data, and extensions
876+
The prefix ``__zarr`` is reserved for core Zarr data, and extensions
877877
can use other files and folders starting with ``__``.
878878

879879

@@ -1162,7 +1162,7 @@ To encode or decode a chunk, the encoded and decoded representations for each
11621162
codec in the chain must first be determined as follows:
11631163

11641164
1. The initial decoded representation, ``decoded_representation[0]`` is a
1165-
multi-dimensional array with the same data type as the zarr array, and shape
1165+
multi-dimensional array with the same data type as the Zarr array, and shape
11661166
equal to the chunk shape.
11671167

11681168
2. For each codec ``i``, the encoded representation is equal to the decoded
@@ -1182,7 +1182,7 @@ the following procedure:
11821182

11831183
1. The initial *encoded chunk* ``EC[0]`` of the type specified by
11841184
``decoded_representation[0]`` is equal to the chunk array ``A`` (with a shape
1185-
equal to the chunk shape, and data type equal to the zarr array data type).
1185+
equal to the chunk shape, and data type equal to the Zarr array data type).
11861186

11871187
2. For each codec ``codecs[i]`` in ``codecs``, ``EC[i+1] :=
11881188
codecs[i].encode(EC[i])``.
@@ -1350,11 +1350,11 @@ A **writeable store** supports the following operations:
13501350
13511351
.. note::
13521352

1353-
Some KV stores do allow creation and update of keys, but not deletion. For
1353+
Some stores allow creating and updating keys, but not deleting them. For
13541354
example, Zip archives do not allow removal of content without recreating the
13551355
full archive.
13561356

1357-
Inability to delete can affect ability to rename keys as well, as a rename
1357+
Inability to delete can impair the ability to rename keys, as a rename
13581358
is often a sequence or atomic combination of a deletion and a creation.
13591359

13601360
A **listable store** supports any one or more of the following
@@ -1373,7 +1373,7 @@ operations:
13731373
For example, if a store contains the keys "a/b", "a/c/d" and
13741374
"e/f/g", then ``list_prefix("a/")`` would return "a/b" and "a/c/d".
13751375

1376-
Note: the behavior of ``list_prefix`` is undefined if ``prefix`` does not end
1376+
Note: the behaviour of ``list_prefix`` is undefined if ``prefix`` does not end
13771377
with a trailing slash ``/`` and the store can assume there is at least one key
13781378
that starts with ``prefix``.
13791379

@@ -1592,7 +1592,7 @@ adding them to the array metadata.
15921592
A storage transformer serves the same `abstract store interface`_ as the store_.
15931593
However, it should not persistently store any information necessary to restore the original data,
15941594
but instead propagates this to the next storage transformer or the final store.
1595-
From the perspective of an array or a previous stage transformer both store and storage transformer follow the same
1595+
From the perspective of an array or a previous stage transformer, both store and storage transformer follow the same
15961596
protocol and can be interchanged regarding the protocol. The behaviour can still be different,
15971597
e.g. requests may be cached or the form of the underlying data can change.
15981598

@@ -1649,23 +1649,23 @@ Implementation Notes
16491649
This section is non-normative and presents notes from implementers about cases
16501650
that need to be carefully considered but do not strictly fall into the spec.
16511651

1652-
Explicit vs implicit group
1653-
--------------------------
1652+
Explicit vs implicit groups
1653+
---------------------------
16541654

1655-
While this zarr spec v3 defines implicit and explicit groups, implementations may
1656-
decide to create an explicit group for all implicit groups they encounter; in
1655+
This specification defines both implicit and explicit groups, but implementations may
1656+
create an explicit group for all implicit groups they encounter, in
16571657
particular when using a hierarchical storage.
16581658

16591659
Erasure of an implicit group may automatically erase any empty parent. For
16601660
example on a S3 store where the namespace is flat, erasure of the last key with
1661-
a prefix will erase all the implicit group in the prefix.
1661+
a prefix will erase all implicit groups in the prefix.
16621662

1663-
Care must thus be taken when erasing an array or a group if the parent needs to
1663+
Care must be taken when erasing an array or a group if the parent needs to
16641664
be converted into an explicit group.
16651665

16661666
A race-condition arises if a client writes an array at path ``P``,
1667-
and another concurrently assumes ``P`` is an implicit group and writes subgroups or arrays into it.
1668-
Implementations may choose to never use implicit groups to avoid this.
1667+
and another client concurrently assumes ``P`` is an implicit group and writes subgroups or arrays into it.
1668+
Implementations can avoid this race condition by exclusively using explicit groups.
16691669

16701670
Resizing
16711671
--------
@@ -1687,7 +1687,7 @@ was not deleted when shrinking the array, this data will be shown by default.
16871687
The latter case should be signalled to the user appropriately. An implementation
16881688
can also allow the user to choose to delete previous data explicitly when
16891689
increasing the array (by writing the fill value into partial chunks and deleting
1690-
others), but this should not be the default behavior.
1690+
others), but this should not be the default behaviour.
16911691

16921692

16931693
Comparison with Zarr v2
@@ -1745,7 +1745,7 @@ Changes after Provisional Acceptance
17451745
Draft Changes
17461746
--------------------------
17471747

1748-
- Removed `extensions` field and clarified extension point behavior, changing the config format of
1748+
- Removed `extensions` field and clarified extension point behaviour, changing the config format of
17491749
data-types, chunk-grid, storage-transformers and codecs. `PR #204
17501750
<https://github.com/zarr-developers/zarr-specs/pull/204>`_
17511751
- Changed `format_version` to the int ``3``, added key ``node_type`` to group and array metadata. `PR #204

0 commit comments

Comments
 (0)