Skip to content

Commit 14db861

Browse files
maxrjonesmaxrjones
committed
Fix numpydoc errors
1 parent e6b629f commit 14db861

File tree

4 files changed

+23
-23
lines changed

4 files changed

+23
-23
lines changed

‎src/zarr/api/asynchronous.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ async def load(
295295
296296
See Also
297297
--------
298-
save, savez
298+
save
299299
300300
Notes
301301
-----

‎src/zarr/core/array.py‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1925,7 +1925,7 @@ def info(self) -> Any:
19251925
ArrayInfo
19261926
19271927
Related
1928-
--------
1928+
-------
19291929
[zarr.AsyncArray.info_complete][] - All information about a group, including dynamic information
19301930
like the number of bytes and chunks written.
19311931
@@ -1963,7 +1963,7 @@ async def info_complete(self) -> Any:
19631963
ArrayInfo
19641964
19651965
Related
1966-
--------
1966+
-------
19671967
[zarr.AsyncArray.info][] - A property giving just the statically known information about an array.
19681968
"""
19691969
return self._info(
@@ -2788,7 +2788,7 @@ def __getitem__(self, selection: Selection) -> NDArrayLikeOrScalar:
27882788
methods listed under Related.
27892789
27902790
Related
2791-
--------
2791+
-------
27922792
[get_basic_selection][zarr.Array.get_basic_selection], [set_basic_selection][zarr.Array.set_basic_selection]
27932793
[get_mask_selection][zarr.Array.get_mask_selection], [set_mask_selection][zarr.Array.set_mask_selection],
27942794
[get_coordinate_selection][zarr.Array.get_coordinate_selection], [set_coordinate_selection][zarr.Array.set_coordinate_selection],
@@ -2889,7 +2889,7 @@ def __setitem__(self, selection: Selection, value: npt.ArrayLike) -> None:
28892889
methods listed under Related.
28902890
28912891
Related
2892-
--------
2892+
-------
28932893
[get_basic_selection][zarr.Array.get_basic_selection],
28942894
[set_basic_selection][zarr.Array.set_basic_selection],
28952895
[get_mask_selection][zarr.Array.get_mask_selection],
@@ -3016,7 +3016,7 @@ def get_basic_selection(
30163016
using the alternative notation.
30173017
30183018
Related
3019-
--------
3019+
-------
30203020
[set_basic_selection][zarr.Array.set_basic_selection],
30213021
[get_mask_selection][zarr.Array.get_mask_selection],
30223022
[set_mask_selection][zarr.Array.set_mask_selection],
@@ -3126,7 +3126,7 @@ def set_basic_selection(
31263126
alternative notation.
31273127
31283128
Related
3129-
--------
3129+
-------
31303130
[get_basic_selection][zarr.Array.get_basic_selection],
31313131
[get_mask_selection][zarr.Array.get_mask_selection],
31323132
[set_mask_selection][zarr.Array.set_mask_selection],
@@ -3254,7 +3254,7 @@ def get_orthogonal_selection(
32543254
Slices with step > 1 are supported, but slices with negative step are not.
32553255
32563256
Related
3257-
--------
3257+
-------
32583258
[get_basic_selection][zarr.Array.get_basic_selection],
32593259
[set_basic_selection][zarr.Array.set_basic_selection],
32603260
[get_mask_selection][zarr.Array.get_mask_selection],
@@ -3374,7 +3374,7 @@ def set_orthogonal_selection(
33743374
Slices with step > 1 are supported, but slices with negative step are not.
33753375
33763376
Related
3377-
--------
3377+
-------
33783378
[get_basic_selection][zarr.Array.get_basic_selection],
33793379
[set_basic_selection][zarr.Array.set_basic_selection],
33803380
[get_mask_selection][zarr.Array.get_mask_selection],
@@ -3461,7 +3461,7 @@ def get_mask_selection(
34613461
arrays by calling `np.nonzero`.
34623462
34633463
Related
3464-
--------
3464+
-------
34653465
[get_basic_selection][zarr.Array.get_basic_selection],
34663466
[set_basic_selection][zarr.Array.set_basic_selection],
34673467
[set_mask_selection][zarr.Array.set_mask_selection],
@@ -3551,7 +3551,7 @@ def set_mask_selection(
35513551
arrays by calling `np.nonzero`.
35523552
35533553
Related
3554-
--------
3554+
-------
35553555
[get_basic_selection][zarr.Array.get_basic_selection],
35563556
[set_basic_selection][zarr.Array.set_basic_selection],
35573557
[get_mask_selection][zarr.Array.get_mask_selection],
@@ -3639,7 +3639,7 @@ def get_coordinate_selection(
36393639
each coordinate array after broadcasting.
36403640
36413641
Related
3642-
--------
3642+
-------
36433643
[get_basic_selection][zarr.Array.get_basic_selection],
36443644
[set_basic_selection][zarr.Array.set_basic_selection],
36453645
[get_mask_selection][zarr.Array.get_mask_selection],
@@ -3731,7 +3731,7 @@ def set_coordinate_selection(
37313731
of the array.
37323732
37333733
Related
3734-
--------
3734+
-------
37353735
[get_basic_selection][zarr.Array.get_basic_selection],
37363736
[set_basic_selection][zarr.Array.set_basic_selection],
37373737
[get_mask_selection][zarr.Array.get_mask_selection],
@@ -3855,7 +3855,7 @@ def get_block_selection(
38553855
[23, 24, 25, 26, 27, 28]])
38563856
38573857
Related
3858-
--------
3858+
-------
38593859
[get_basic_selection][zarr.Array.get_basic_selection],
38603860
[set_basic_selection][zarr.Array.set_basic_selection],
38613861
[get_mask_selection][zarr.Array.get_mask_selection],
@@ -3955,7 +3955,7 @@ def set_block_selection(
39553955
Slices are supported. However, only with a step size of one.
39563956
39573957
Related
3958-
--------
3958+
-------
39593959
[get_basic_selection][zarr.Array.get_basic_selection],
39603960
[set_basic_selection][zarr.Array.set_basic_selection],
39613961
[get_mask_selection][zarr.Array.get_mask_selection],
@@ -4119,7 +4119,7 @@ def info(self) -> Any:
41194119
ArrayInfo
41204120
41214121
Related
4122-
--------
4122+
-------
41234123
[zarr.Array.info_complete][] - All information about a group,
41244124
including dynamic information like the number of bytes and chunks written.
41254125
@@ -4155,7 +4155,7 @@ def info_complete(self) -> Any:
41554155
ArrayInfo
41564156
41574157
Related
4158-
--------
4158+
-------
41594159
[zarr.Array.info][] - The statically known subset of metadata about an array.
41604160
"""
41614161
return sync(self._async_array.info_complete())
@@ -4178,7 +4178,7 @@ async def _shards_initialized(
41784178
The keys of the chunks that have been initialized.
41794179
41804180
Related
4181-
--------
4181+
-------
41824182
[nchunks_initialized][zarr.Array.nchunks_initialized]
41834183
41844184
"""

‎src/zarr/core/group.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -865,7 +865,7 @@ def info(self) -> Any:
865865
GroupInfo
866866
867867
Related
868-
--------
868+
-------
869869
[zarr.AsyncGroup.info_complete][]
870870
All information about a group, including dynamic information
871871
"""
@@ -889,7 +889,7 @@ async def info_complete(self) -> Any:
889889
GroupInfo
890890
891891
Related
892-
--------
892+
-------
893893
[zarr.AsyncGroup.info][]
894894
"""
895895
members = [x[1].metadata async for x in self.members(max_depth=None)]
@@ -2076,7 +2076,7 @@ def info(self) -> Any:
20762076
GroupInfo
20772077
20782078
Related
2079-
--------
2079+
-------
20802080
[zarr.Group.info_complete][]
20812081
All information about a group, including dynamic information
20822082
like the children members.
@@ -2095,7 +2095,7 @@ def info_complete(self) -> Any:
20952095
GroupInfo
20962096
20972097
Related
2098-
--------
2098+
-------
20992099
[zarr.Group.info][]
21002100
"""
21012101
return self._sync(self._async_group.info_complete())

‎src/zarr/core/indexing.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ def _iter_regions(
183183
The linear indexing order to use.
184184
185185
Yields
186-
-------
186+
------
187187
188188
Iterator[tuple[slice, ...]]
189189
An iterator over tuples of slices, where each slice spans a separate contiguous region

0 commit comments

Comments
 (0)