Skip to content

Commit 9438415

Browse files
committed
Documented that the target parent directory must exist
1 parent ca39080 commit 9438415

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

docs/guide.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ zappend(os.listdir("inputs"), target_dir="output/mycube.zarr")
1616

1717
Both invocations will create the Zarr dataset `output/mycube.zarr` by concatenating
1818
the "slice" datasets provided in the `inputs` directory along their `time` dimension.
19-
Both the CLI command and the Python function can be run without any further
19+
`target_dir` must specify a directory for the Zarr dataset. (Its parent directory must
20+
exist.) Both the CLI command and the Python function can be run without any further
2021
configuration provided the paths of the target dataset and the source slice datasets
2122
are given. The target dataset path must point to a directory that will contain a Zarr
2223
group to be created and updated. The slice dataset paths may be provided as Zarr as
@@ -433,6 +434,7 @@ You can disable transaction management by specifying
433434
The `target_dir` setting is mandatory. If it is not specified in the configuration,
434435
it must be passed either as `--target` or `-t` option to the `zappend` command or as
435436
`target_dir` keyword argument when using the `zappend` Python function.
437+
Note, the parent directory of `target_dir` must already exist.
436438

437439
If the target path is given for another filesystem, additional storage options may be
438440
passed using the optional `target_storage_options` setting.

zappend/config/schema.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -520,7 +520,7 @@
520520
target_dir={
521521
"description": (
522522
"The URI or local path of the target Zarr dataset."
523-
" Must be a directory."
523+
" Must specify a directory whose parent directory must exist."
524524
),
525525
"type": "string",
526526
"minLength": 1,

0 commit comments

Comments
 (0)