cmd: rephrase intro of run #1537
Conversation
jorgeorpinel
changed the title
jorgeorpinel
changed the title
| usage: dvc run [-h] [-q | -v] [-d <path>] [-n <name>] [-o <path>] | ||
| usage: dvc run [-h] [-q | -v] -n <name> [-d <path>] [-o <path>] |
There was a problem hiding this comment.
If -n is required, why is is printed in [] here?
There was a problem hiding this comment.
@jorgeorpinel Because it is not strictly required, we have a hidden --single-stage hack for which it is not required. Thanks for fixing it in the docs!
There was a problem hiding this comment.
Ok good to know.
P/s should the -h output
-n NAME, --name NAME Stage name.
Say it's (usually) required?
| command Command to execute. | ||
| command Command for the stage. Executed by default |
There was a problem hiding this comment.
Help desc. update!
There was a problem hiding this comment.
Looks really strange w/o a dot at the end
There was a problem hiding this comment.
My bad, I think this is actually a full sentence (with implicit subject & verb "It's").
There was a problem hiding this comment.
Fixing in #1540
There was a problem hiding this comment.
technically, the command may or may not execute (think of run-cache
If it's in the run cache it means the results are applied at dvc run again. From the user's perspective this is the same as executing it again (instantly).
you want to do the PR on core
Yes, will do... ⏳
There was a problem hiding this comment.
@jorgeorpinel, I don't see any difference between previous and this version. It only adds confusion (what does by default mean?). It'd be better to explain the cases where it won't be executed.
There was a problem hiding this comment.
I think @skshetry is right, I don't think we need to explain when it's not executed, thats is what --no-exec reference is for. Maybe we should replace Only create stage file without actually running it. -> Create stage file without actually executing its command. Since we are operating on command and execute in main ref
There was a problem hiding this comment.
@skshetry you don't see a difference between "Command to execute" and "Command for the stage" ? The former reflected run being a command to run commands (what it used to be), the latter reflects it being a helper to define stages (what it is now, see the cmd ref Description).
I thought we were just discussing the "Executed by default" which I don't have a strong opinion on, tbh. Removed in #1550 (let's continue this part of the discussion there?)
Maybe we should replace Only create stage file without actually running it. -> Create stage file without actually executing its command.
@pared I agree. Or use the text from the cmd ref: create a stage file, but do not execute the command defined in it, nor cache dependencies or outputs
* cmd: rephrase intro of run per #1526 (comment) * cmd: typo in run -h out per #1537 (comment)
No description provided.