Skip to content

Commit a1d6475

Browse files
committed
Fixed mumbo-jambo in docs
1 parent 178bf8d commit a1d6475

File tree

3 files changed

+8
-10
lines changed

3 files changed

+8
-10
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,9 @@ The `zappend` tool provides the following features:
4040
* **CLI and Python API**: The tool can be used in a shell using the [`zappend`](cli.md)
4141
command or from Python. When used from Python using the
4242
[`zappend()`](api.md) function, slice datasets can be passed as local file paths,
43-
URIs, or as in-memory datasets of type
44-
[xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html).
45-
Users can implement their own _slice sources_ and provide them to the that provide
46-
slice dataset objects and are disposed after each slice has been processed.
43+
URIs, as datasets of type
44+
[xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html), or as custom
45+
[zappend.api.SliceSource](https://bcdev.github.io/zappend/api/#class-slicesource) objects.
4746

4847

4948

docs/index.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,9 @@ The `zappend` tool provides the following features:
3434
* **CLI and Python API**: The tool can be used in a shell using the [`zappend`](cli.md)
3535
command or from Python. When used from Python using the
3636
[`zappend()`](api.md) function, slice datasets can be passed as local file paths,
37-
URIs, or as in-memory datasets of type
38-
[xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html).
39-
Users can implement their own _slice sources_ and provide them to the that provide
40-
slice dataset objects and are disposed after each slice has been processed.
37+
URIs, as datasets of type
38+
[xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html), or as custom
39+
[zappend.api.SliceSource](https://bcdev.github.io/zappend/api/#class-slicesource) objects.
4140

4241
## How It Works
4342

zappend/slice/abc.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ class SliceSource(ABC):
2828
2929
The utility functions
3030
[to_slice_factories()][zappend.slice.factory.to_slice_factories] and
31-
[to_slice_factory()][zappend.slice.factory.to_slice_factory] ease passing slice
32-
specific inputs to your custom slice source.
31+
[to_slice_factory()][zappend.slice.factory.to_slice_factory] ease passing
32+
slice-specific inputs to your custom slice source.
3333
3434
Args:
3535
ctx: The processing context.

0 commit comments

Comments
 (0)