Skip to content

Commit 2d9e77c

Browse files
committed
Merge branch 'forman-82-slice_source_is_cm' into forman-82-slice_source_kwargs
2 parents f1d989d + d23f902 commit 2d9e77c

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

zappend/config/config.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,9 +122,14 @@ def slice_engine(self) -> str | None:
122122

123123
@property
124124
def slice_source(self) -> Callable[[...], Any] | None:
125-
"""The configured slice source type. If given, it must be
126-
a callable that returns a value of type `SliceItem` or a class that is
127-
derived from `SliceSource` abstract base class.
125+
"""A class or function that receives a
126+
slice item as argument(s) and provides the slice dataset.
127+
128+
* If a class is given, it must be derived from `zappend.api.SliceSource`.
129+
* If the function is a context manager, it must yield an `xarray.Dataset`.
130+
* If a plain function is given, it must return any valid slice item type.
131+
132+
Refer to the user guide for more information.
128133
"""
129134
return self._slice_source
130135

0 commit comments

Comments
 (0)