Skip to content

Commit 59ac9ed

Browse files
committed
lint docstring
1 parent eb93c24 commit 59ac9ed

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

src/zarr/storage/local.py

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,31 @@
77
from pathlib import Path
88
from typing import TYPE_CHECKING
99

10-
from zarr.abc.store import ByteRangeRequest, Store
10+
from zarr.abc.store import Store
1111
from zarr.core.buffer import Buffer
1212
from zarr.core.common import concurrent_map
1313

1414
if TYPE_CHECKING:
1515
from collections.abc import AsyncGenerator, Iterable
1616
from typing import Self
1717

18+
from zarr.abc.store import ByteRangeRequest
1819
from zarr.core.buffer import BufferPrototype
1920
from zarr.core.common import AccessModeLiteral
2021

2122

22-
def _get(
23-
path: Path, prototype: BufferPrototype, byte_range: tuple[int | None, int | None] | None
24-
) -> Buffer:
23+
def _get(path: Path, prototype: BufferPrototype, byte_range: ByteRangeRequest | None) -> Buffer:
2524
"""
2625
Fetch a contiguous region of bytes from a file.
2726
2827
Parameters
2928
----------
30-
path: Path
29+
30+
path : Path
3131
The file to read bytes from.
32-
byte_range: tuple[int, int | None] | None = None
32+
prototype : BufferPrototype
33+
The buffer prototype to use when reading the bytes.
34+
byte_range : tuple[int | None, int | None] | None = None
3335
The range of bytes to read. If `byte_range` is `None`, then the entire file will be read.
3436
If `byte_range` is a tuple, the first value specifies the index of the first byte to read,
3537
and the second value specifies the total number of bytes to read. If the total value is
@@ -86,7 +88,7 @@ class LocalStore(Store):
8688
8789
Parameters
8890
----------
89-
root : str or Path
91+
path : str or Path
9092
Directory to use as root of store.
9193
mode : str
9294
Mode in which to open the store. Either 'r', 'r+', 'a', 'w', 'w-'.
@@ -97,7 +99,7 @@ class LocalStore(Store):
9799
supports_deletes
98100
supports_partial_writes
99101
supports_listing
100-
root
102+
path
101103
"""
102104

103105
supports_writes: bool = True

0 commit comments

Comments
 (0)