From e86eb116e822c0997639268f4c49da63ff851ef8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Redzy=C5=84ski?= Date: Fri, 18 Dec 2020 13:22:57 +0100 Subject: [PATCH 1/3] params: document --targets option --- content/docs/command-reference/params/diff.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/content/docs/command-reference/params/diff.md b/content/docs/command-reference/params/diff.md index 02a51fa522..422d6c750f 100644 --- a/content/docs/command-reference/params/diff.md +++ b/content/docs/command-reference/params/diff.md @@ -7,7 +7,8 @@ commits in the DVC repository, or between a commit and the ## Synopsis ```usage -usage: dvc params diff [-h] [-q | -v] [--all] [--show-json] [--show-md] +usage: dvc params diff [-h] [-q | -v] [--targets [ [ ...]]] + [--all] [--show-json] [--show-md] [--no-path] [a_rev] [b_rev] positional arguments: @@ -35,6 +36,20 @@ itself does not ascribe any specific meaning for these values. ## Options +- `--targets` - Limit command scope to these params files. When specifying + arguments for `--targets` before `revisions`, you should use `--` after this + option's arguments, e.g.: + + ```dvc + $ dvc params diff --targets m1.json m2.yaml -- HEAD v1 + ``` + + Alternatively, you can also run the above statement as: + + ```dvc + $ dvc params diff HEAD v1 --targets m1.json m2.json + ``` + - `--all` - prints all parameters including not changed. - `--show-json` - prints the command's output in easily parsable JSON format, From 42c61b54aebe4758ff605b1fd5eca9238bd27841 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Redzy=C5=84ski?= Date: Mon, 21 Dec 2020 13:20:14 +0100 Subject: [PATCH 2/3] Update content/docs/command-reference/params/diff.md Co-authored-by: Jorge Orpinel --- content/docs/command-reference/params/diff.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/command-reference/params/diff.md b/content/docs/command-reference/params/diff.md index 422d6c750f..cf4f531ff0 100644 --- a/content/docs/command-reference/params/diff.md +++ b/content/docs/command-reference/params/diff.md @@ -36,7 +36,7 @@ itself does not ascribe any specific meaning for these values. ## Options -- `--targets` - Limit command scope to these params files. When specifying +- `--targets ` - limit command scope to these params files. When specifying arguments for `--targets` before `revisions`, you should use `--` after this option's arguments, e.g.: From 2064cceec6b0aa2c5b50f6306b306f4b0280cb79 Mon Sep 17 00:00:00 2001 From: "restyled-io[bot]" <32688539+restyled-io[bot]@users.noreply.github.com> Date: Mon, 21 Dec 2020 12:20:58 -0800 Subject: [PATCH 3/3] Restyled by prettier (#2042) Co-authored-by: Restyled.io --- content/docs/command-reference/params/diff.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/docs/command-reference/params/diff.md b/content/docs/command-reference/params/diff.md index cf4f531ff0..cc4316324e 100644 --- a/content/docs/command-reference/params/diff.md +++ b/content/docs/command-reference/params/diff.md @@ -36,9 +36,9 @@ itself does not ascribe any specific meaning for these values. ## Options -- `--targets ` - limit command scope to these params files. When specifying - arguments for `--targets` before `revisions`, you should use `--` after this - option's arguments, e.g.: +- `--targets ` - limit command scope to these params files. When + specifying arguments for `--targets` before `revisions`, you should use `--` + after this option's arguments, e.g.: ```dvc $ dvc params diff --targets m1.json m2.yaml -- HEAD v1