Skip to content

Commit 27037fa

Browse files
committed
style: zarr -> Zarr, americanize behavior, clean up some prose
1 parent e86f824 commit 27037fa

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

docs/v3/core/v3.0.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -839,7 +839,7 @@ apply to node names:
839839
* must not be a string composed only of period characters, e.g. ``"."`` or ``".."``
840840
* must not start with the reserved prefix ``"__"``
841841

842-
To ensure consistent behaviour across different storage systems and programming
842+
To ensure consistent behavior across different storage systems and programming
843843
languages, we recommend users to only use characters in the sets ``a-z``,
844844
``A-Z``, ``0-9``, ``-``, ``_``, ``.``.
845845

@@ -1223,7 +1223,7 @@ codec specification must declare the codec identifier, and describe
12231223
(or cite documents that describe) the encoding and decoding algorithms
12241224
and the format of the encoded data.
12251225

1226-
A codec may have configuration parameters which modify the behaviour
1226+
A codec may have configuration parameters which modify the behavior
12271227
of the codec in some way. For example, a compression codec may have a
12281228
compression level parameter, which is an integer that affects the
12291229
resulting compression ratio of the data. Configuration parameters must
@@ -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 creatiing 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
@@ -1592,8 +1592,8 @@ 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
1596-
protocol and can be interchanged regarding the protocol. The behaviour can still be different,
1595+
From the perspective of an array or a previous stage transformer, both store and storage transformer follow the same
1596+
protocol and can be interchanged regarding the protocol. The behavior can still be different,
15971597
e.g. requests may be cached or the form of the underlying data can change.
15981598

15991599
Storage transformers may be stacked to combine different functionalities:
@@ -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
1652+
Explicit vs implicit groups
16531653
--------------------------
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
--------

0 commit comments

Comments
 (0)