Skip to content

Commit 31e63aa

Browse files
committed
add docstrings and export warnings
1 parent d322cad commit 31e63aa

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

src/zarr/errors.py

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
"GroupNotFoundError",
99
"MetadataValidationError",
1010
"NodeTypeValidationError",
11+
"ZarrDeprecationWarning",
12+
"ZarrFutureWarning",
1113
]
1214

1315

@@ -61,14 +63,20 @@ class MetadataValidationError(BaseZarrError):
6163

6264
class NodeTypeValidationError(MetadataValidationError):
6365
"""
64-
Specialized exception when the node_type of the metadata document is incorrect..
66+
Specialized exception when the node_type of the metadata document is incorrect.
6567
6668
This can be raised when the value is invalid or unexpected given the context,
6769
for example an 'array' node when we expected a 'group'.
6870
"""
6971

7072

71-
class ZarrFutureWarning(FutureWarning): ...
73+
class ZarrFutureWarning(FutureWarning):
74+
"""
75+
A warning raised to indicate when a construct will change semantically in the future.
76+
"""
7277

7378

74-
class ZarrDeprecationWarning(DeprecationWarning): ...
79+
class ZarrDeprecationWarning(DeprecationWarning):
80+
"""
81+
A warning raised to indicate that a construct will be removed in a future release.
82+
"""

0 commit comments

Comments
 (0)