Misc. updates #1978
Misc. updates #1978
Conversation
jorgeorpinel
temporarily deployed
to
dvc-landing-jorge-zct3dcllfnv7
jorgeorpinel
temporarily deployed
to
dvc-landing-jorge-zct3dcllfnv7
jorgeorpinel
temporarily deployed
to
dvc-landing-jorge-zct3dcllfnv7
jorgeorpinel
temporarily deployed
to
dvc-landing-jorge-zct3dcllfnv7
jorgeorpinel
temporarily deployed
to
dvc-landing-jorge-zct3dcllfnv7
jorgeorpinel
temporarily deployed
to
dvc-landing-jorge-zct3dcllfnv7
jorgeorpinel
temporarily deployed
to
dvc-landing-jorge-zct3dcllfnv7
| Get tracked files or directories from | ||
| [remote storage](/doc/command-reference/remote) into the <abbr>cache</abbr>. | ||
| Download <abbr>cache</abbr> files or directories from | ||
| [remote storage](/doc/command-reference/remote), based on the current `dvc.yaml` | ||
| and `.dvc` files. |
There was a problem hiding this comment.
- Needs matching core update
UPDATE: cmd: matching help output to docs dvc#4989
per content/docs/command-reference/commit.md
jorgeorpinel
temporarily deployed
to
dvc-landing-jorge-zct3dcllfnv7
|
Oops I forgot about this PR! Addressing now... |
| import metadata is saved to the `.dvc` file. You can use `dvc commit` to | ||
| finish the operation. | ||
| - `--no-exec` - create the import `.dvc` file but don't download `url` (assumes | ||
| that the data source is valid). You can use `dvc commit` to finish the |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
There was a problem hiding this comment.
Separately, I wonder why repro doesn't have --no-exec and why import* don't have --no-commit. Is it worth asking on the core repo?
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
| @@ -25,8 +25,8 @@ next. | |||
| 💡 For convenience, a pre-commit Git hook is available to remind you to | |||
| `dvc commit` when needed. See `dvc install` for more info. | |||
|
|
|||
| Mainly, `dvc commit` provides a way to complete DVC commands that track data | |||
| (`dvc add`, `dvc repro`, `dvc import`, etc.), when they have been used with the | |||
| `dvc commit` provides a way to complete DVC commands that track data (`dvc add`, | |||
There was a problem hiding this comment.
Sometimes after executing a stage, we realize that not all of its dependencies
or outputs are defined in `dvc.yaml`. It is possible to
[add the missing deps/outs](/docs/user-guide/how-to/add-deps-or-outs-to-a-stage),
and `dvc commit` may be needed to finalize the remedy (see link).
contradicts this. (and probably the previous version as well)
There was a problem hiding this comment.
I don't see the contradiction, but maybe the way this is written gives that impression? Here's what each use case means:
- Finish add/run/repro --no-commit/exec
- Cache missing outputs that you forgot to add to dvc.yaml before but now added (after executing the stage)
There was a problem hiding this comment.
Clarified a little in ffff0a4 but it's not a big change.
There was a problem hiding this comment.
Contradiction here is that you we state "Mainly" and then clarify "Specifically", but point is completely different from the one in the "Mainly" section. To my mind either introductory section should be completely removed, or generalized if we keep it this way. wdyt?
There was a problem hiding this comment.
Just to clarify, the the "Mainly" word was deleted in the lines above 🙂
either introductory section should be completely removed, or generalized
The intro is "Stores the current contents..." which is already a general explanation. That p ends in "We explore the scenarios next" and the desc goes on to the main scenario ("provides a way to complete add/repro --no-commit etc."). Then we have a list of other scenarios but we wanted to use the word "Specifically" there.
So I'm a bit confused, why delete the main scenario? Do you mean move it down to the list? How about reinstating "Other" instead of "Specific"? That was my originally intended structure for this Description (summarizing: intro, main scenario, list of secondary scenarios).
| - `--no-exec` - write the stage to `dvc.yaml`, but do not execute the `command`. | ||
| DVC will still add the outputs to `.gitignore`, but they won't be cached or | ||
| recorded in `dvc.lock` (like with `--no-commit` below). You can use | ||
| `dvc repro` to finish the operation. This is useful if you need to define a |
There was a problem hiding this comment.
I think we can omit now You can use dvc repro to finish the operation.
I wonder if we also simplify the long sentence further somehow ...
There was a problem hiding this comment.
we can omit now You can use dvc repro
True, it was repeated. Removed. And I did find a way to simplify the text (dce4cc8) so it's 20-30% shorter now. PTAL
TBH I would completely remove the mentions of --no-cache and dvc commit here too. It may be unnecessary (implied/obvious).
* cmd: matching help output to docs per iterative/dvc.org#1971 (review) and iterative/dvc.org#1978 (review) * fetch: simplify help text per iterative/dvc.org#1978 (review) * commit: update help output to match iterative/dvc.org/pull/1978 * fetch: update help output to match iterative/dvc.org/pull/1978 * commmit: help output update (again) * remove: simplify help output per iterative/dvc.org#1971 (review) * remove: simplify help output per iterative/dvc.org#1971 (review) * commit: update -h output per iterative/dvc.org#1989 (review)
* cmd: matching help output to docs per iterative/dvc.org#1971 (review) and iterative/dvc.org#1978 (review) * fetch: simplify help text per iterative/dvc.org#1978 (review)
Update commit and --no-commit optionsExtracted to 1989Note for self: