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

term: review "download" in the context of get and import commands, et al. #825

Closed
jorgeorpinel opened this issue Nov 28, 2019 · 4 comments · Fixed by #846
Closed

term: review "download" in the context of get and import commands, et al. #825

jorgeorpinel opened this issue Nov 28, 2019 · 4 comments · Fixed by #846
Labels
A: docs Area: user documentation (gatsby-theme-iterative)

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Nov 28, 2019

(Perhaps also dvc fetch, dvc checkout? Look for others.)

This is because when the data source for an of these commands is located in the same file system where the command is running, there may be no downloading involved, bust simply a copy (or reflink).

For example (and where this issue came from): dvc get {local_repo_url} path will at some point just copy from the external repo's cache dir instead of going to its remote storage (see iterative/dvc/issues/2599) but even now, if that repo has a local remote configured, then the operation is a copy. And regardless of the implementation detail (whether its an HTTP GET request, S3 API, cp --reflink, etc.), to the user, getting a file from another local file system repo doesn't "feel like" downloading anything.

See also discussions in iterative/dvc#2837 (review) and #821 (review).

Possible solutions envisioned so far:

  • Just use "download". The copy scenarios are edge cases and it may not be worth it complicating docs with possibly confusing and longer phrases to catch all possible behaviors.
  • Use "download/copy" and/or "copy or download" appropriatly for maximum correctness.
  • Use more general terms like "obtain" or "retrieve" when ambiguity is needed (currently used in dvc get cmd ref. per get: add example on downloading normal git files #821).

p.s. this will affect some output strings in the iterative/dvc repo which will need it's own PR.

@shcheklein
Copy link
Member

👍 for one simple term for the sake of simplicity. I'm fine with download + some explanation in the command reference.

@jorgeorpinel
Copy link
Contributor Author

Any opinion on this @danihodovic, @efiop? Thanks.

@danihodovic
Copy link
Contributor

danihodovic commented Nov 28, 2019

I have no strong opinions as long as the docs are consistent.

@efiop
Copy link
Contributor

efiop commented Nov 29, 2019

@jorgeorpinel I agree with @shcheklein and @danihodovic 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants