Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: describe the purpose for --instance in download #1053

Merged
merged 2 commits into from
Jul 8, 2022
Merged

DOC: describe the purpose for --instance in download #1053

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
403d977
DOC: describe the purpose for --instance in download
yarikoptic Jul 8, 2022
4940ea2
Improved description of --instance
yarikoptic Jul 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion dandi/cli/cmd_download.py
View file
Open in desktop
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