cmd ref: dvc run 1.0 update #1420
Conversation
This comment has been minimized.
This comment has been minimized.
adding simple dvc run usage examples and creating a section about escaping commands
expand more on stage commands
content/docs/install/plugins.md
Outdated
| autocmd! BufNewFile,BufRead Dvcfile,*.dvc setfiletype yaml | ||
| autocmd! BufNewFile,*.dvc setfiletype yaml |
There was a problem hiding this comment.
Can someone who uses Vim confirm this though? Maybe @efiop (since I'm about to ping you about something else 😬)
There was a problem hiding this comment.
@jorgeorpinel Just from looking at it, seems like it is broken and should be:
autocmd! BufNewFile,BufRead *.dvc setfiletype yaml
but I would actually keep Dvcfile for now, since it might still be present in older repos.
There was a problem hiding this comment.
Good point, will roll this back for now.
| - `--external` - allow outputs that are outside of the DVC repository. See | ||
| [Managing External Data](/doc/user-guide/managing-external-data). | ||
|
|
||
| - `--file <path>` - specify name of the YAML file this command will generate or |
There was a problem hiding this comment.
Not true. --file is ignored for any stages created with -n.
There was a problem hiding this comment.
Yeah that's right but so hmmm what does --file do? This is what the master branch of the core repo outputs:
--file <filename> Specify name of the DVC-file this command will generate.
We don't even have DVC-files anymore!
There was a problem hiding this comment.
Also
stages created with -n
-n is always required no? Lil confused rn
There was a problem hiding this comment.
Oops, looks like --single-stage is hidden. --single-stage flag is available in dvc run that keeps the same behavior as the 0.X dvc had, regarding single stage files. This -f is a vestige of that. We might reuse -f if we introduce custom named dvc.yaml file someday. But, for dvc.yaml, it's ignored, so, we can just drop it from the documentation altogether.
There was a problem hiding this comment.
Wait, this is a command reference. So, maybe, we should document -f and --single-stage here too.
There was a problem hiding this comment.
Interesting! I didn't know about --single-stage.
for dvc.yaml, it's ignored, so, we can just drop it from the documentation altogether
Yep, I'll just remove it for now. But it should probably be hidden from the help output in core too? Idk 😕
There was a problem hiding this comment.
... and it's ignored for dvc.yaml
Co-authored-by: Saugat Pachhai <[email protected]>
|
Merged since we are releasing DVC 1.0 tmr. Please let's keep iterating in the new PR |
|
Continuation PR: #1479 |
* cmd ref: update run usage and options to 1.0a10 * cmd ref: run desc update (1) * term: remove some instances of Dvcfile (per dvc run updates) * cmd ref: run desc update (2) * term: metric files -> metrics and plots files in run desc per #1420 (review) * cmd ref: improve run desc. by adding simple dvc run usage examples and creating a section about escaping commands * cmd ref: expand "Stage commands" section of run * cmd ref: make run desc more dvc.yaml-centric and expand more on stage commands * cmd ref: run desc and option impros per private feedback * cmd ref reorg run desc sections and improve cmd examples * install: roll back Vim plugin change per #1420 (review) * user guide: document how wdir works in dirs&files per #1420 (review) * cmd ref: expand deps&outs section of run with examples, et al. * cmd ref: remove incorrect note about param files * cmd ref: rewrite basic examples of run * cmd ref: update remaining examples of run ref. * cmd ref: a few details per private feedback (on run) * cmd ref: rename params example in run per #1420 (review) * Update content/docs/command-reference/run.md Co-authored-by: Saugat Pachhai <[email protected]> * cmd ref: move note about deps and params up * cmd ref: improve note about params in run * cmd ref: try to slim fown and reord run * cmd ref: remove run --file option per #1420 (comment) * cmd ref: improvements to run per private feedback (1) * cmd ref: improvements to run per private feedback (2) * cmd ref: improvements to run per private feedback (3) * cmd ref: improvements to run per private feedback (4) * cmd ref: improve examples in run per private feedback Co-authored-by: Saugat Pachhai <[email protected]>
Bring
dvc runup to date.