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.

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

Conversation

yarikoptic
Copy link
Member

attn @waxlamp -- is it better?

@yarikoptic yarikoptic requested a review from jwodder July 8, 2022 19:51
@codecov
Copy link

codecov bot commented Jul 8, 2022

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.40%. Comparing base (ddf46f2) to head (4940ea2).
Report is 1057 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1053   +/-   ##
=======================================
  Coverage   88.40%   88.40%           
=======================================
  Files          71       71           
  Lines        9159     9159           
=======================================
  Hits         8097     8097           
  Misses       1062     1062           
Flag Coverage Δ
unittests 88.40% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Comment on lines 91 to 93
help="Instance of DANDI archive to use. If URLs provided, we would ensure that "
"they point to the same instance as specified. If no URLs provided, that "
"instance will be used for identifier found in local dandiset.yaml.",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested rewording:

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you please send it as suggestion (select multiple lines before clicking on suggestion icon)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

indeed is better than mine, accepted

dandi/cli/cmd_download.py Outdated Show resolved Hide resolved
Co-authored-by: John T. Wodder II <jwodder@users.noreply.github.com>
@yarikoptic yarikoptic merged commit 50ca7b0 into master Jul 8, 2022
@yarikoptic yarikoptic deleted the enh-download-doc branch July 8, 2022 23:54
@github-actions
Copy link

🚀 PR was released in 0.45.0 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants