Skip to content

Commit b9699f5

Browse files
authored
Note that whole directories can be deleted in LocalStore (#2606)
1 parent 2998561 commit b9699f5

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

src/zarr/storage/local.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,18 @@ async def set_partial_values(
189189
await concurrent_map(args, asyncio.to_thread, limit=None) # TODO: fix limit
190190

191191
async def delete(self, key: str) -> None:
192+
"""
193+
Remove a key from the store.
194+
195+
Parameters
196+
----------
197+
key : str
198+
199+
Notes
200+
-----
201+
If ``key`` is a directory within this store, the entire directory
202+
at ``store.root / key`` is deleted.
203+
"""
192204
# docstring inherited
193205
self._check_writable()
194206
path = self.root / key

0 commit comments

Comments
 (0)