From c5ca3da2b0518b352b82c81932c54adcebcd6f14 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Perez Date: Wed, 9 Mar 2022 02:13:34 -0600 Subject: [PATCH 1/5] ref: rewrap a couple usage blocks per https://github.com/iterative/dvc.org/pull/3325#pullrequestreview-903978598 and https://github.com/iterative/dvc.org/pull/3325#pullrequestreview-903978835 --- content/docs/command-reference/run.md | 11 ++++++----- content/docs/command-reference/stage/add.md | 16 ++++++++-------- 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/content/docs/command-reference/run.md b/content/docs/command-reference/run.md index 3f550cb399..ef6ac84c01 100644 --- a/content/docs/command-reference/run.md +++ b/content/docs/command-reference/run.md @@ -7,11 +7,12 @@ command. ```usage usage: dvc run [-h] [-q | -v] [-n ] [--no-exec] [--no-run-cache] - [--no-commit] [-d ] [-o ] [-O ] - [-p [:]] [-m ] [-M ] - [--plots ] [--plots-no-cache ] [--live ] - [--live-no-cache ] [--live-no-html] - [-w ] [-f] [--outs-persist ] + [--no-commit] [-d ] [-o ] + [-O ] [-p [:]] + [-m ] [-M ] [--plots ] + [--plots-no-cache ] [--live ] + [--live-no-cache ] [--live-no-html] [-w ] + [-f] [--outs-persist ] [--outs-persist-no-cache ] [-c ] [--always-changed] [--external] [--desc ] command diff --git a/content/docs/command-reference/stage/add.md b/content/docs/command-reference/stage/add.md index 42deffba2f..19f04bacca 100644 --- a/content/docs/command-reference/stage/add.md +++ b/content/docs/command-reference/stage/add.md @@ -5,16 +5,16 @@ Helper command to create or update stages in `dvc.yaml`. ## Synopsis ```usage -usage: dvc stage add [-h] [-q | -v] -n [-d ] [-o ] - [-O ] [-p [:]] - [-m ] [-M ] [--plots ] +usage: dvc stage add [-h] [-q | -v] -n [-d ] + [-o ] [-O ] + [-p [:]] [-m ] + [-M ] [--plots ] [--plots-no-cache ] [--live ] [--live-no-cache ] [--live-no-html] - [-w ] [-f] - [--outs-persist ] - [--outs-persist-no-cache ] [-c ] - [--always-changed] [--external] [--desc ] - + [-w ] [-f] [--outs-persist ] + [--outs-persist-no-cache ] + [-c ] [--always-changed] [--external] + [--desc ] command positional arguments: From 04910876cbf88edea7a1853d69fee99d1f08819e Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Perez Date: Wed, 9 Mar 2022 02:43:23 -0600 Subject: [PATCH 2/5] ref: reorg repro/run/stage add usage block --- content/docs/command-reference/repro.md | 6 +++--- content/docs/command-reference/run.md | 18 +++++++++-------- content/docs/command-reference/stage/add.md | 22 ++++++++++----------- 3 files changed, 24 insertions(+), 22 deletions(-) diff --git a/content/docs/command-reference/repro.md b/content/docs/command-reference/repro.md index 9608db241a..dd5dc0c9d3 100644 --- a/content/docs/command-reference/repro.md +++ b/content/docs/command-reference/repro.md @@ -7,9 +7,9 @@ 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] [-s] [-m] [-i] [-p] [-P] [-R] + [--dry] [--pull] [--no-run-cache] [--no-commit] + [--downstream] [--force-downstream] [--glob] [targets [ ...]] positional arguments: diff --git a/content/docs/command-reference/run.md b/content/docs/command-reference/run.md index ef6ac84c01..5b808489e2 100644 --- a/content/docs/command-reference/run.md +++ b/content/docs/command-reference/run.md @@ -6,14 +6,16 @@ command. ## Synopsis ```usage -usage: dvc run [-h] [-q | -v] [-n ] [--no-exec] [--no-run-cache] - [--no-commit] [-d ] [-o ] - [-O ] [-p [:]] - [-m ] [-M ] [--plots ] - [--plots-no-cache ] [--live ] - [--live-no-cache ] [--live-no-html] [-w ] - [-f] [--outs-persist ] - [--outs-persist-no-cache ] [-c ] +usage: dvc run [-h] [-q | -v] [-n ] [-f] + [--no-exec] [--no-run-cache] [--no-commit] + [-d ] [-p [:]] + [-o ] [-O ] [-c ] + [--outs-persist ] + [--outs-persist-no-cache ] + [-m ] [-M ] + [--plots ] [--plots-no-cache ] + [--live ] [--live-no-cache ] + [--live-no-html] [-w ] [--always-changed] [--external] [--desc ] command diff --git a/content/docs/command-reference/stage/add.md b/content/docs/command-reference/stage/add.md index 19f04bacca..1f0f6ce537 100644 --- a/content/docs/command-reference/stage/add.md +++ b/content/docs/command-reference/stage/add.md @@ -5,17 +5,17 @@ Helper command to create or update stages in `dvc.yaml`. ## Synopsis ```usage -usage: dvc stage add [-h] [-q | -v] -n [-d ] - [-o ] [-O ] - [-p [:]] [-m ] - [-M ] [--plots ] - [--plots-no-cache ] [--live ] - [--live-no-cache ] [--live-no-html] - [-w ] [-f] [--outs-persist ] - [--outs-persist-no-cache ] - [-c ] [--always-changed] [--external] - [--desc ] - command +usage: dvc stage add [-h] [-q | -v] -n [-f] + [-d ] [-p [:]] + [-o ] [-O ] [-c ] + [--outs-persist ] + [--outs-persist-no-cache ] + [-m ] [-M ] + [--plots ] [--plots-no-cache ] + [--live ] [--live-no-cache ] + [--live-no-html] [-w ] + [--always-changed] [--external] [--desc ] + command positional arguments: command Command to execute From 630fb6a66184a9b9ad77427b1d13484ce4f39aa8 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Perez Date: Mon, 28 Mar 2022 20:04:30 -0600 Subject: [PATCH 3/5] move run/repro exec modifyer options down per https://github.com/iterative/dvc.org/pull/3345#discussion_r835554525 --- content/docs/command-reference/exp/run.md | 7 +++---- content/docs/command-reference/repro.md | 8 +++++--- content/docs/command-reference/run.md | 10 +++++----- 3 files changed, 13 insertions(+), 12 deletions(-) diff --git a/content/docs/command-reference/exp/run.md b/content/docs/command-reference/exp/run.md index 0844b93c0c..2265e03edd 100644 --- a/content/docs/command-reference/exp/run.md +++ b/content/docs/command-reference/exp/run.md @@ -7,7 +7,7 @@ Run or resume a ```usage usage: dvc exp run [-h] [-q | -v] [-f] - [repro_options ...] + { repro options ... } [-S [:]] [--queue] [--run-all] [-j ] [--temp] [-r ] [--reset] @@ -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 [:]=`, `--set-param [:]=` - set the value of diff --git a/content/docs/command-reference/repro.md b/content/docs/command-reference/repro.md index dd5dc0c9d3..4ab5f83b52 100644 --- a/content/docs/command-reference/repro.md +++ b/content/docs/command-reference/repro.md @@ -7,9 +7,11 @@ correct order. ## Synopsis ```usage -usage: dvc repro [-h] [-q | -v] [-f] [-s] [-m] [-i] [-p] [-P] [-R] - [--dry] [--pull] [--no-run-cache] [--no-commit] - [--downstream] [--force-downstream] [--glob] +usage: dvc repro [-h] [-q | -v] [-f] [-i] + [-s] [-p] [-P] [-R] + [--downstream] [--force-downstream] + [--dry] [--no-commit] [--no-run-cache] + [--pull] [-m] [--glob] [targets [ ...]] positional arguments: diff --git a/content/docs/command-reference/run.md b/content/docs/command-reference/run.md index 5b808489e2..5b818b1a94 100644 --- a/content/docs/command-reference/run.md +++ b/content/docs/command-reference/run.md @@ -7,16 +7,16 @@ command. ```usage usage: dvc run [-h] [-q | -v] [-n ] [-f] - [--no-exec] [--no-run-cache] [--no-commit] [-d ] [-p [:]] [-o ] [-O ] [-c ] - [--outs-persist ] + [--external] [--outs-persist ] [--outs-persist-no-cache ] [-m ] [-M ] [--plots ] [--plots-no-cache ] - [--live ] [--live-no-cache ] - [--live-no-html] [-w ] - [--always-changed] [--external] [--desc ] + [--no-exec] [--no-commit] [--no-run-cache] + [--always-changed] [--live ] + [--live-no-cache ] [--live-no-html] + [-w ] [--desc ] command positional arguments: From d3c7aaedea69a8eb70e1d547b2e43856e47a381c Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 30 Mar 2022 15:43:30 -0600 Subject: [PATCH 4/5] Update content/docs/command-reference/repro.md Co-authored-by: Dave Berenbaum --- content/docs/command-reference/repro.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/content/docs/command-reference/repro.md b/content/docs/command-reference/repro.md index 4ab5f83b52..3168b6410f 100644 --- a/content/docs/command-reference/repro.md +++ b/content/docs/command-reference/repro.md @@ -8,10 +8,9 @@ correct order. ```usage usage: dvc repro [-h] [-q | -v] [-f] [-i] - [-s] [-p] [-P] [-R] - [--downstream] [--force-downstream] - [--dry] [--no-commit] [--no-run-cache] - [--pull] [-m] [--glob] + [-s] [-p] [-P] [-R] [-m] + [--downstream] [--force-downstream] [--glob] + [--dry] [--no-commit] [--no-run-cache] [--pull] [targets [ ...]] positional arguments: From cb88988e500749893fd8c44c1113f7cdf165ab3a Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Perez Date: Wed, 30 Mar 2022 15:52:19 -0600 Subject: [PATCH 5/5] ref: make run options like stage add per https://github.com/iterative/dvc.org/pull/3345#pullrequestreview-926544597 --- content/docs/command-reference/run.md | 6 +++--- content/docs/command-reference/stage/add.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/content/docs/command-reference/run.md b/content/docs/command-reference/run.md index 5b818b1a94..5f534eaee5 100644 --- a/content/docs/command-reference/run.md +++ b/content/docs/command-reference/run.md @@ -13,10 +13,10 @@ usage: dvc run [-h] [-q | -v] [-n ] [-f] [--outs-persist-no-cache ] [-m ] [-M ] [--plots ] [--plots-no-cache ] + [--live ] [--live-no-cache ] + [--live-no-html] [-w ] + [--always-changed] [--desc ] [--no-exec] [--no-commit] [--no-run-cache] - [--always-changed] [--live ] - [--live-no-cache ] [--live-no-html] - [-w ] [--desc ] command positional arguments: diff --git a/content/docs/command-reference/stage/add.md b/content/docs/command-reference/stage/add.md index 1f0f6ce537..218ead53d2 100644 --- a/content/docs/command-reference/stage/add.md +++ b/content/docs/command-reference/stage/add.md @@ -8,13 +8,13 @@ Helper command to create or update stages in `dvc.yaml`. usage: dvc stage add [-h] [-q | -v] -n [-f] [-d ] [-p [:]] [-o ] [-O ] [-c ] - [--outs-persist ] + [--external] [--outs-persist ] [--outs-persist-no-cache ] [-m ] [-M ] [--plots ] [--plots-no-cache ] [--live ] [--live-no-cache ] [--live-no-html] [-w ] - [--always-changed] [--external] [--desc ] + [--always-changed] [--desc ] command positional arguments: