Skip to content

ref: rewrap a couple usage blocks #3345

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.

Sign up for GitHub

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

Merged
merged 8 commits into from
Mar 30, 2022
Merged

ref: rewrap a couple usage blocks #3345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c5ca3da
ref: rewrap a couple usage blocks
jorgeorpinel Mar 9, 2022
0491087
ref: reorg repro/run/stage add usage block
jorgeorpinel Mar 9, 2022
0883741
Merge branch 'master' into dvclive/refs-rewrap
jorgeorpinel Mar 29, 2022
630fb6a
move run/repro exec modifyer options down
jorgeorpinel Mar 29, 2022
1300083
Merge branch 'master' into dvclive/refs-rewrap
jorgeorpinel Mar 30, 2022
d3c7aae
Update content/docs/command-reference/repro.md
jorgeorpinel Mar 30, 2022
3327af1
Merge branch 'dvclive/refs-rewrap' of github.com:iterative/dvc.org in…
jorgeorpinel Mar 30, 2022
cb88988
ref: make run options like stage add
jorgeorpinel Mar 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions content/docs/command-reference/exp/run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Run or resume a

```usage
usage: dvc exp run [-h] [-q | -v] [-f]
[repro_options ...]
{ repro options ... }
[-S [<filename>:]<params_list>]
[--queue] [--run-all] [-j <number>] [--temp]
[-r <experiment_rev>] [--reset]
Expand Down Expand Up @@ -64,9 +64,8 @@ committing them to the Git repo. Unnecessary ones can be [cleared] with

## Options

> In addition to the following, `dvc exp run` accepts all the options in
> `dvc repro`, with the exception of `--glob`, `--no-commit`, and
> `--no-run-cache`.
> In addition to the following, `dvc exp run` accepts the options in `dvc repro`
> except for `--glob`, `--no-commit`, and `--no-run-cache`.

- `-S [<filename>:]<param_name>=<param_value>`,
`--set-param [<filename>:]<param_name>=<param_value>` - set the value of
Expand Down
7 changes: 4 additions & 3 deletions content/docs/command-reference/repro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ correct order.
## Synopsis

```usage
usage: dvc repro [-h] [-q | -v] [-f] [-s] [-m] [--dry] [-i]
[-p] [-P] [-R] [--no-run-cache] [--force-downstream]
[--no-commit] [--downstream] [--pull] [--glob]
usage: dvc repro [-h] [-q | -v] [-f] [-i]
[-s] [-p] [-P] [-R] [-m]
[--downstream] [--force-downstream] [--glob]
[--dry] [--no-commit] [--no-run-cache] [--pull]
[targets [<target> ...]]

positional arguments:
Expand Down
19 changes: 11 additions & 8 deletions content/docs/command-reference/run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,17 @@ command.
## Synopsis

```usage
usage: dvc run [-h] [-q | -v] [-n <name>] [--no-exec] [--no-run-cache]
[--no-commit] [-d <path>] [-o <filename>] [-O <filename>]
[-p [<filename>:]<params_list>] [-m <path>] [-M <path>]
[--plots <path>] [--plots-no-cache <path>] [--live <path>]
[--live-no-cache <path>] [--live-no-html]
[-w <path>] [-f] [--outs-persist <filename>]
[--outs-persist-no-cache <filename>] [-c <filename>]
[--always-changed] [--external] [--desc <text>]
usage: dvc run [-h] [-q | -v] [-n <name>] [-f]
[-d <path>] [-p [<filename>:]<params_list>]
[-o <filename>] [-O <filename>] [-c <filename>]
[--external] [--outs-persist <filename>]
[--outs-persist-no-cache <filename>]
[-m <path>] [-M <path>]
[--plots <path>] [--plots-no-cache <path>]
[--live <path>] [--live-no-cache <path>]
[--live-no-html] [-w <path>]
[--always-changed] [--desc <text>]
[--no-exec] [--no-commit] [--no-run-cache]
command

positional arguments:
Expand Down
22 changes: 11 additions & 11 deletions content/docs/command-reference/stage/add.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ Helper command to create or update <abbr>stages</abbr> in `dvc.yaml`.
## Synopsis

```usage
usage: dvc stage add [-h] [-q | -v] -n <name> [-d <path>] [-o <filename>]
[-O <filename>] [-p [<filename>:]<params_list>]
[-m <path>] [-M <path>] [--plots <path>]
[--plots-no-cache <path>] [--live <path>]
[--live-no-cache <path>] [--live-no-html]
[-w <path>] [-f]
[--outs-persist <filename>]
[--outs-persist-no-cache <filename>] [-c <filename>]
[--always-changed] [--external] [--desc <text>]

command
usage: dvc stage add [-h] [-q | -v] -n <name> [-f]
[-d <path>] [-p [<filename>:]<params_list>]
[-o <filename>] [-O <filename>] [-c <filename>]
[--external] [--outs-persist <filename>]
[--outs-persist-no-cache <filename>]
[-m <path>] [-M <path>]
[--plots <path>] [--plots-no-cache <path>]
[--live <path>] [--live-no-cache <path>]
[--live-no-html] [-w <path>]
[--always-changed] [--desc <text>]
command

positional arguments:
command Command to execute
Expand Down