Skip to content

Commit cf207ae

Browse files
authored
Merge pull request #106 from davidbrochart/rename_delete
Rename delete to erase
2 parents a15892b + 169693f commit cf207ae

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

docs/protocol/core/v3.0.rst

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1184,12 +1184,12 @@ A **writeable store** supports the following operations:
11841184
| Parameters: `key`, `value`
11851185
| Output: none
11861186
1187-
``delete`` - Delete the given key/value pair from the store.
1187+
``erase`` - Erase the given key/value pair from the store.
11881188

11891189
| Parameters: `key`
11901190
| Output: none
11911191
1192-
``delete_prefix`` - Delete all keys with the given prefix from the store:
1192+
``erase_prefix`` - Erase all keys with the given prefix from the store:
11931193

11941194
| Parameter: `prefix`
11951195
| Output: none
@@ -1283,7 +1283,7 @@ Storage protocol
12831283
================
12841284

12851285
This section describes how to translate high level operations to
1286-
create, delete or modify Zarr hierarchies, groups or arrays, into low
1286+
create, erase or modify Zarr hierarchies, groups or arrays, into low
12871287
level operations on the key/value store interface defined above.
12881288

12891289
In this section a "hierarchy path" is a logical path which identifies
@@ -1458,31 +1458,31 @@ Let "+" be the string concatenation operator.
14581458
arrays. All intermediate prefixes ending in a ``/`` are implicit
14591459
groups.
14601460

1461-
**Delete a group or array**
1461+
**Erase a group or array**
14621462

1463-
To delete an array at path `P`:
1464-
- delete the metadata document for the array, ``delete(array_meta_key(P))``
1465-
- delete all data keys which prefix have path pointing to this array,
1466-
``delete_prefix("data/root" + P + "/")``
1463+
To erase an array at path `P`:
1464+
- erase the metadata document for the array, ``erase(array_meta_key(P))``
1465+
- erase all data keys which prefix have path pointing to this array,
1466+
``erase_prefix("data/root" + P + "/")``
14671467

1468-
To delete an implicit group at path `P`:
1469-
- delete all nodes under this group - it should be sufficient to
1470-
perform ``delete_prefix("meta/root" + P + "/")`` and
1471-
``delete_prefix("data/root" + P + "/")``.
1468+
To erase an implicit group at path `P`:
1469+
- erase all nodes under this group - it should be sufficient to
1470+
perform ``erase_prefix("meta/root" + P + "/")`` and
1471+
``erase_prefix("data/root" + P + "/")``.
14721472

1473-
To delete an explicit group at path `P`:
1474-
- delete the metadata document for the group, ``delete(group_meta_key(P))``
1475-
- delete all nodes under this group - it should be sufficient to
1476-
perform ``delete_prefix("meta/root" + P + "/")`` and
1477-
``delete_prefix("data/root" + P + "/")``.
1473+
To erase an explicit group at path `P`:
1474+
- erase the metadata document for the group, ``erase(group_meta_key(P))``
1475+
- erase all nodes under this group - it should be sufficient to
1476+
perform ``erase_prefix("meta/root" + P + "/")`` and
1477+
``erase_prefix("data/root" + P + "/")``.
14781478

14791479
Note that store implementation may decide to reify implicit groups
1480-
and thus protocol implementation should attempt to delete the
1481-
group metadata file if they really wish to delete an empty
1480+
and thus protocol implementation should attempt to erase the
1481+
group metadata file if they really wish to erase an empty
14821482
implicit group. @@TODO clarify this
14831483

1484-
Store implementation are also allowed to delete any implicit parent of a
1485-
deleted implicit groups, so a protocol implementation should make sure to
1484+
Store implementation are also allowed to erase any implicit parent of an
1485+
erased implicit group, so a protocol implementation should make sure to
14861486
reify a parent group if they need to keep it. @@TODO clarify this
14871487

14881488

0 commit comments

Comments
 (0)