Removed condescending language from Command Reference #1522
Conversation
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Thanks for the small typo and grammar corrections 🙂
This PR is big... I only reviewed your first 6 changed files for now. Please try to apply my comments to all the other files I didn't review yet, where/if applicable.
Also, please copy the changes that you think are valid from https://github.com/iterative/dvc.org/pull/1396/files.
| @@ -158,7 +158,7 @@ baseline-experiment <- First simple version of the model | |||
| bigrams-experiment <- Uses bigrams to improve the model | |||
| ``` | |||
|
|
|||
| We can now just run `dvc checkout` that will update the most recent `model.pkl`, | |||
| We can now run `dvc checkout` that will update the most recent `model.pkl`, | |||
There was a problem hiding this comment.
| We can now run `dvc checkout` that will update the most recent `model.pkl`, | |
| We can now run `dvc checkout` to update the most recent `model.pkl`, |
The paragraph will need formatting after this change though.
Same as in https://github.com/iterative/dvc.org/pull/1396/files#diff-d159337499c6716e1d89e1c12b5a8d09
| 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 |
There was a problem hiding this comment.
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.
@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.
no strong opinion, we can change it
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.
| 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 |
There was a problem hiding this comment.
Same here: new workspace; fresh workspace; clean workspace — something like that
| @@ -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.
| One could do a `dvc fetch` to get all the data, but what if you only want to | |
| We could use `dvc fetch` to get all the data, but what if you only want to |
| > (just download the file or directory). | ||
| > (just downloads the file or directory). |
There was a problem hiding this comment.
Good. But what about the other change from https://github.com/iterative/dvc.org/pull/1396/files#diff-06ee43874ed57c5e9a7512621fba5ed1L81-R81 ?
`remote://myremote/path/to/file` notation just means -> The `remote://myremote/path/to/file` notation means please
|
Hi @mformihir, will you be continuing this contribution? Thanks |
jorgeorpinel
dismissed
their stale review
Looks like I'm going to have to finish this one...
|
Closing this as stale. |
Address #1394 (partially)