Skip to content

Commit 4518653

Browse files
dstansbyd-v-b
andauthored
More consistent store docstrings (#2976)
Co-authored-by: Davis Bennett <[email protected]>
1 parent a0761ac commit 4518653

File tree

7 files changed

+13
-9
lines changed

7 files changed

+13
-9
lines changed

src/zarr/storage/_fsspec.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232

3333
class FsspecStore(Store):
3434
"""
35-
A remote Store based on FSSpec
35+
Store for remote data based on FSSpec.
3636
3737
Parameters
3838
----------

src/zarr/storage/_local.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ def _put(
6767

6868
class LocalStore(Store):
6969
"""
70-
Local file system store.
70+
Store for the local file system.
7171
7272
Parameters
7373
----------

src/zarr/storage/_logging.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
class LoggingStore(WrapperStore[T_Store]):
2626
"""
27-
Store wrapper that logs all calls to the wrapped store.
27+
Store that logs all calls to another wrapped store.
2828
2929
Parameters
3030
----------

src/zarr/storage/_memory.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
class MemoryStore(Store):
2121
"""
22-
In-memory store.
22+
Store for local memory.
2323
2424
Parameters
2525
----------
@@ -173,8 +173,10 @@ async def list_dir(self, prefix: str) -> AsyncIterator[str]:
173173

174174

175175
class GpuMemoryStore(MemoryStore):
176-
"""A GPU only memory store that stores every chunk in GPU memory irrespective
177-
of the original location.
176+
"""
177+
Store for GPU memory.
178+
179+
Stores every chunk in GPU memory irrespective of the original location.
178180
179181
The dictionary of buffers to initialize this memory store with *must* be
180182
GPU Buffers.

src/zarr/storage/_obstore.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@
3737

3838

3939
class ObjectStore(Store):
40-
"""A Zarr store that uses obstore for fast read/write from AWS, GCP, Azure.
40+
"""
41+
Store that uses obstore for fast read/write from AWS, GCP, Azure.
4142
4243
Parameters
4344
----------

src/zarr/storage/_wrapper.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818

1919
class WrapperStore(Store, Generic[T_Store]):
2020
"""
21-
A store class that wraps an existing ``Store`` instance.
21+
Store that wraps an existing Store.
22+
2223
By default all of the store methods are delegated to the wrapped store instance, which is
2324
accessible via the ``._store`` attribute of this class.
2425

src/zarr/storage/_zip.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
class ZipStore(Store):
2626
"""
27-
Storage class using a ZIP file.
27+
Store using a ZIP file.
2828
2929
Parameters
3030
----------

0 commit comments

Comments
 (0)