-
Notifications
You must be signed in to change notification settings - Fork 394
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
Removed condescending language from Command Reference #1522
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -96,8 +96,8 @@ reproducibility in those cases. | |
|
||
## Examples | ||
|
||
Let's employ a simple <abbr>workspace</abbr> with some data, code, ML models, | ||
pipeline stages, such as the <abbr>DVC project</abbr> created for the | ||
Let's employ a <abbr>workspace</abbr> with some data, code, ML models, pipeline | ||
stages, such as the <abbr>DVC project</abbr> created for the | ||
Comment on lines
-99
to
+100
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure this is condescending but no strong opinion, we can change it. However, I believe this same paragraph exists in other refs. such as in checkout so let's apply the change consistently everywhere please. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @mformihir what about the use of "just" in this doc? See https://github.com/iterative/dvc.org/pull/1396/files#diff-aac9973cd919dc8d6735e0de82ab7f62L47-R47 Do you think it's condescending? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
On this, also. I'm not sure the phrase "Let's employ a workspace with some data..." reads right, without the adjective. Let's change the word "simple" for something more specific such as "new" or "fresh" please. |
||
[Get Started](/doc/tutorials/get-started). Then we can see what happens with | ||
`git commit` and `dvc commit` in different situations. | ||
|
||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -120,8 +120,8 @@ or `-T` options are used). | |||||
|
||||||
## Examples | ||||||
|
||||||
Let's employ a simple <abbr>workspace</abbr> with some data, code, ML models, | ||||||
pipeline stages, such as the <abbr>DVC project</abbr> created for the | ||||||
Let's employ a <abbr>workspace</abbr> with some data, code, ML models, pipeline | ||||||
stages, such as the <abbr>DVC project</abbr> created for the | ||||||
Comment on lines
-123
to
+124
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same here: new workspace; fresh workspace; clean workspace — something like that |
||||||
[Get Started](/doc/tutorials/get-started). Then we can see what happens with | ||||||
`dvc fetch` as we switch from tag to tag. | ||||||
|
||||||
|
@@ -166,8 +166,8 @@ bigrams-experiment <- use bigrams to improve the model | |||||
## Example: Default behavior | ||||||
|
||||||
This project comes with a predefined HTTP | ||||||
[remote storage](/doc/command-reference/remote). We can now just run `dvc fetch` | ||||||
to download the most recent `model.pkl`, `data.xml`, and other DVC-tracked files | ||||||
[remote storage](/doc/command-reference/remote). We can now run `dvc fetch` to | ||||||
download the most recent `model.pkl`, `data.xml`, and other DVC-tracked files | ||||||
into our local <abbr>cache</abbr>. | ||||||
|
||||||
```dvc | ||||||
|
@@ -256,8 +256,8 @@ $ dvc status -c | |||||
deleted: data/data.xml | ||||||
``` | ||||||
|
||||||
One could do a simple `dvc fetch` to get all the data, but what if you only want | ||||||
to retrieve the data up to our third stage, `train.dvc`? We can use the | ||||||
One could do a `dvc fetch` to get all the data, but what if you only want to | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
retrieve the data up to our third stage, `train.dvc`? We can use the | ||||||
`--with-deps` (or `-d`) option: | ||||||
|
||||||
```dvc | ||||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -31,7 +31,7 @@ external data source changes. Example scenarios: | |
- A shared dataset on a remote storage that is managed and updated outside DVC. | ||
|
||
> Note that `dvc get-url` corresponds to the first step this command performs | ||
> (just download the file or directory). | ||
> (just downloads the file or directory). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good. But what about the other change from https://github.com/iterative/dvc.org/pull/1396/files#diff-06ee43874ed57c5e9a7512621fba5ed1L81-R81 ?
|
||
|
||
The `dvc import-url` command helps the user create such an external data | ||
dependency without having to manually copying files from the supported remote | ||
|
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.
The paragraph will need formatting after this change though.