Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
added a BC: workspace document #2197
added a BC: workspace document #2197
Changes from 6 commits
168a290
3130952
c8d77e6
d119729
e0d915e
bdbcc97
7f2e93d
523f1c1
50964b1
46fe4bb
7a88ff5
44af0a9
42559e2
6cc0f6c
e85a0d7
5674991
0b099f6
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a note to remove this comment later before merging (but for now it's useful to have the list during review 👍)
This comment was marked as resolved.
Sorry, something went wrong.
This comment was marked as off-topic.
Sorry, something went wrong.
This comment was marked as resolved.
Sorry, something went wrong.
This comment was marked as resolved.
Sorry, something went wrong.
This comment was marked as resolved.
Sorry, something went wrong.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But actually
add
can also download data to the workspace (see--out
and--to-remote
options). Also,import*
commands download AND track data. You may want to rephrase this part accordingly 🙂There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sometimes I think there is no command that hasn't got a duplicate, somehow :) I try to mention commands in passing, if we'd consider each and every option to commands, we'll need to duplicate the command reference here IMHO.
We may just delete the commands if you would like.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can also list all possibilities for each functionality, like
In the workspace, you can
dvc add --out
,dvc import-url
...)but I think this will turn the document into a list of commands and options.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No need to list every command usage of course, agreed!
My point was that these 3 commands mentioned actually overlap in a way that makes the current text slightly incorrect. In any case, the main use case of
add
is not to "add" but to "track", actually. Please check each cmd ref to try to find the right terms when needed 🙂"Download" is correct for
get/import
butadd
can also download (and they can all "transfer") so I'd avoid that term probably. And in fact I wouldn't even mentionget
here, since it doesn't require a DVC project/workspace. Forimport
I'd try to use the cmd name as the relevant action (to "import") I guess...There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
then again
import*
also track the downloaded data 😅 ("adds"). Maybe it should be a single sentence about tracking and put alladd
,import
,import-url
in the same parenthesis.