Skip to content

Commit 0449ef7

Browse files
committed
add a section about --verbose to the docs
1 parent f301172 commit 0449ef7

File tree

1 file changed

+25
-12
lines changed

1 file changed

+25
-12
lines changed

docs/user-guide/cli.rst

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -70,18 +70,6 @@ Note there is also a shortcut to migrate and remove v2 metadata in one step:
7070
$ zarr migrate v3 path/to/input.zarr --remove-v2-metadata
7171
7272
73-
Dry run
74-
--------
75-
All commands provide a ``--dry-run`` option that will log changes that would be made on a real run, without creating
76-
or modifying any files.
77-
78-
.. code-block:: bash
79-
80-
$ zarr migrate v3 path/to/input.zarr --dry-run
81-
82-
Dry run enabled - no new files will be created or changed. Log of files that would be created on a real run:
83-
Saving metadata to path/to/input.zarr/zarr.json
84-
8573
Remove metadata
8674
----------------
8775

@@ -106,6 +94,31 @@ To override this behaviour use ``--force``:
10694
10795
$ zarr remove-metadata v3 path/to/input.zarr --force
10896
97+
98+
Dry run
99+
--------
100+
All commands provide a ``--dry-run`` option that will log changes that would be made on a real run, without creating
101+
or modifying any files.
102+
103+
.. code-block:: bash
104+
105+
$ zarr migrate v3 path/to/input.zarr --dry-run
106+
107+
Dry run enabled - no new files will be created or changed. Log of files that would be created on a real run:
108+
Saving metadata to path/to/input.zarr/zarr.json
109+
110+
111+
Verbose
112+
--------
113+
You can also add ``--verbose`` **before** any command, to see a full log of its actions:
114+
115+
.. code-block:: bash
116+
117+
$ zarr --verbose migrate v3 path/to/input.zarr
118+
119+
$ zarr --verbose remove-metadata v2 path/to/input.zarr
120+
121+
109122
Equivalent functions
110123
--------------------
111124
All features of the command-line interface are also available via functions under

0 commit comments

Comments
 (0)