Skip to content

Commit

Permalink
Merge pull request #1053 from dandi/enh-download-doc
Browse files Browse the repository at this point in the history
DOC: describe the purpose for --instance in download
  • Loading branch information
yarikoptic committed Jul 8, 2022
2 parents 75540c8 + 4940ea2 commit 50ca7b0
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion dandi/cli/cmd_download.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,15 @@ def get_metavar(self, param):
@click.option(
"--sync", is_flag=True, help="Delete local assets that do not exist on the server"
)
@instance_option(default=None)
@instance_option(
default=None,
help=(
"DANDI Archive instance to download from. If any URLs are provided,"
" they must point to the given instance. If no URL is provided, and"
" there is a local dandiset.yaml file, the Dandiset with the identifier"
" given in the file will be downloaded from the given instance."
),
)
# Might be a cool feature, not unlike verifying a checksum, we verify that
# downloaded file passes the validator, and if not -- alert
# @click.option(
Expand Down

0 comments on commit 50ca7b0

Please sign in to comment.