Skip to content

Commit 50ca7b0

Browse files
authored
Merge pull request #1053 from dandi/enh-download-doc
DOC: describe the purpose for --instance in download
2 parents 75540c8 + 4940ea2 commit 50ca7b0

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

dandi/cli/cmd_download.py

+9-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,15 @@ def get_metavar(self, param):
8686
@click.option(
8787
"--sync", is_flag=True, help="Delete local assets that do not exist on the server"
8888
)
89-
@instance_option(default=None)
89+
@instance_option(
90+
default=None,
91+
help=(
92+
"DANDI Archive instance to download from. If any URLs are provided,"
93+
" they must point to the given instance. If no URL is provided, and"
94+
" there is a local dandiset.yaml file, the Dandiset with the identifier"
95+
" given in the file will be downloaded from the given instance."
96+
),
97+
)
9098
# Might be a cool feature, not unlike verifying a checksum, we verify that
9199
# downloaded file passes the validator, and if not -- alert
92100
# @click.option(

0 commit comments

Comments
 (0)