Skip to content

Commit ba9a08a

Browse files
committed
Enhanced documentation including docstrings
1 parent 976faf5 commit ba9a08a

File tree

3 files changed

+15
-10
lines changed

3 files changed

+15
-10
lines changed

docs/cli.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
# Command Line Interface Reference
22

3-
4-
53
```
64
Usage: zappend [OPTIONS] [SLICES]...
75
8-
Create or update a Zarr dataset TARGET from slice datasets SLICES.
6+
Create or update a Zarr datacube TARGET from slice datasets SLICES.
7+
8+
The zappend command concatenates the dataset SLICES along a given append
9+
dimension, e.g., `"time"` (the default) for geospatial satellite
10+
observations. Each append step is atomic, that is, the append operation is a
11+
transaction that can be rolled back, in case the append operation fails.
12+
This ensures integrity of the target data cube given by TARGET or in CONFIG.
913
1014
Options:
1115
-c, --config CONFIG Configuration JSON or YAML file. If multiple are

zappend/api.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,9 @@ def zappend(
3838
"""
3939
Robustly create or update a Zarr dataset from dataset slices.
4040
41-
It concatenates the dataset slices from given `slices` along a given append
42-
dimension, e.g., `"time"` (the default) for geospatial satellite observations.
41+
The `zappend` function concatenates the dataset slices from given `slices` along a
42+
given append dimension, e.g., `"time"` (the default) for geospatial satellite
43+
observations.
4344
Each append step is atomic, that is, the append operation is a transaction
4445
that can be rolled back, in case the append operation fails.
4546
This ensures integrity of the target data cube `target_dir` given in `config`

zappend/cli.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,11 @@ def zappend(
4343
):
4444
"""Create or update a Zarr datacube TARGET from slice datasets SLICES.
4545
46-
It concatenates the dataset SLICES along a given append dimension, e.g., `"time"`
47-
(the default) for geospatial satellite observations. Each append step is atomic,
48-
that is, the append operation is a transaction that can be rolled back, in case
49-
the append operation fails. This ensures integrity of the target data cube given
50-
by TARGET or in CONFIG.
46+
The zappend command concatenates the dataset SLICES along a given append dimension,
47+
e.g., `"time"` (the default) for geospatial satellite observations.
48+
Each append step is atomic, that is, the append operation is a transaction that can
49+
be rolled back, in case the append operation fails. This ensures integrity of the
50+
target data cube given by TARGET or in CONFIG.
5151
"""
5252

5353
if help_config:

0 commit comments

Comments
 (0)