Skip to content

Commit

Permalink
Document short aliases --csv/--json/--md flags (#2877)
Browse files Browse the repository at this point in the history
* document short aliases --csv/--json/--md

* Restyled by prettier (#2878)

Co-authored-by: Restyled.io <[email protected]>

* Restyle Document short aliases `--csv/--json/--md` flags (#2948)

* Restyled by prettier

* Update show.md

* Update show.md

Co-authored-by: Restyled.io <[email protected]>
Co-authored-by: Ivan Shcheklein <[email protected]>

Co-authored-by: restyled-io[bot] <32688539+restyled-io[bot]@users.noreply.github.com>
Co-authored-by: Restyled.io <[email protected]>
Co-authored-by: Ivan Shcheklein <[email protected]>
  • Loading branch information
4 people authored Oct 20, 2021
1 parent 96cb495 commit 9c7def0
Show file tree
Hide file tree
Showing 8 changed files with 34 additions and 35 deletions.
16 changes: 8 additions & 8 deletions content/docs/command-reference/diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ workspace.
```usage
usage: dvc diff [-h] [-q | -v]
[--targets [<paths> [<paths> ...]]]
[--show-json] [--show-hash] [--show-md]
[--json] [--show-hash] [--md]
[a_rev] [b_rev]
positional arguments:
Expand All @@ -30,9 +30,9 @@ branch or tag name, Git commit hash, etc.
It defaults to comparing the current workspace and the last commit (`HEAD`), if
arguments `a_rev` and `b_rev` are not specified.

Options `--show-json` and `--show-hash` can be used to modify format of the
output of this command. See the [Options](#options) and [Examples](#examples)
sections below for more details.
Options `--json` and `--show-hash` can be used to modify format of the output of
this command. See the [Options](#options) and [Examples](#examples) sections
below for more details.

`dvc diff` does not have an effect when the repository is not tracked by Git,
for example when `dvc init` was used with the `--no-scm` option.
Expand All @@ -56,10 +56,10 @@ for example when `dvc init` was used with the `--no-scm` option.
$ dvc diff --targets t1.json t2.yaml -- HEAD v1
```

- `--show-json` - prints the command's output in easily parsable JSON format,
instead of a human-readable table.
- `--json` - prints the command's output in easily parsable JSON format, instead
of a human-readable table.

- `--show-md` - prints the command's output in Markdown table format.
- `--md` - prints the command's output in Markdown table format.

- `--show-hash` - print file and directory hash values along with their path.
Useful for debug purposes.
Expand Down Expand Up @@ -188,7 +188,7 @@ Let's use the same command as above, but with JSON output and including hash
values:

```dvc
$ dvc diff --show-json --show-hash \
$ dvc diff --json --show-hash \
baseline-experiment bigrams-experiment
```

Expand Down
8 changes: 4 additions & 4 deletions content/docs/command-reference/exp/diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Show changes in [metrics](/doc/command-reference/metrics) and

```usage
usage: dvc exp diff [-h] [-q | -v] [--all] [--param-deps]
[--show-json] [--show-md] [--old]
[--json] [--md] [--old]
[--no-path] [--precision <n>]
[a_rev] [b_rev]
positional arguments:
Expand Down Expand Up @@ -54,10 +54,10 @@ all the current experiments (without comparisons).

- `--param-deps` - include only parameters that are stage dependencies.

- `--show-json` - prints the command's output in easily parsable JSON format,
instead of a human-readable table.
- `--json` - prints the command's output in easily parsable JSON format, instead
of a human-readable table.

- `--show-md` - prints the command's output in the Markdown table format
- `--md` - prints the command's output in the Markdown table format
([GFM](https://github.github.com/gfm/#tables-extension-)).

- `--old` - include the "Old" value column in addition to the new "Value" (and
Expand Down
11 changes: 5 additions & 6 deletions content/docs/command-reference/exp/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ usage: dvc exp show [-h] [-q | -v] [-a] [-T] [-A] [-n <num>]
[--exclude-params <params_list>] [--param-deps]
[--sort-by <metric/param>]
[--sort-order {asc,desc}] [--no-timestamp] [--sha]
[--show-json] [--show-csv] [--show-md]
[--precision <n>]
[--json] [--csv] [--md] [--precision <n>]
```

## Description
Expand Down Expand Up @@ -113,13 +112,13 @@ metric or param.
- `--sha` - display Git commit (SHA) hashes instead of branch, tag, or
experiment names.

- `--show-json` - prints the command's output in easily parsable JSON format,
instead of a human-readable table.
- `--json` - prints the command's output in easily parsable JSON format, instead
of a human-readable table.

- `--show-csv` - prints the command's output in CSV format instead of a
- `--csv` - prints the command's output in CSV format instead of a
human-readable table.

- `--show-md` - prints the command's output in Markdown table format.
- `--md` - prints the command's output in Markdown table format.

- `--precision <n>` -
[round](https://docs.python.org/3/library/functions.html#round) decimal values
Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ and by Git.

```usage
usage: dvc list [-h] [-q | -v] [-R] [--dvc-only]
[--show-json] [--rev [<commit>]]
[--json] [--rev [<commit>]]
url [path]
positional arguments:
Expand Down Expand Up @@ -67,8 +67,8 @@ accessed with `dvc get`, `dvc import`, or `dvc.api`.
[Git revision](https://git-scm.com/docs/revisions)) of the repository to list
content for. The latest commit in `master` (tip of the default branch) is used
by default when this option is not specified.
- `--show-json` - prints the command's output in easily parsable JSON format,
instead of a human-readable table.
- `--json` - prints the command's output in easily parsable JSON format, instead
of a human-readable table.

- `-h`, `--help` - prints the usage/help message, and exit.

Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/metrics/diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Compare [metrics](/doc/command-reference/metrics) between two commits in the
```usage
usage: dvc metrics diff [-h] [-q | -v]
[--targets [<paths> [<paths> ...]]] [-R]
[--all] [--show-json] [--show-md] [--no-path]
[--all] [--json] [--md] [--no-path]
[--old] [--precision <n>]
[a_rev] [b_rev]
Expand Down Expand Up @@ -66,10 +66,10 @@ all the current metrics (without comparisons).

- `--all` - list all metrics, including those without changes.

- `--show-json` - prints the command's output in JSON format (machine-readable)
- `--json` - prints the command's output in JSON format (machine-readable)
instead of a human-readable table.

- `--show-md` - prints the command's output in the Markdown table format
- `--md` - prints the command's output in the Markdown table format
([GFM](https://github.github.com/gfm/#tables-extension-)).

- `--old` - include the "Old" value column in addition to the new "Value" (and
Expand Down
8 changes: 4 additions & 4 deletions content/docs/command-reference/metrics/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Print [metrics](/doc/command-reference/metrics), with optional formatting.

```usage
usage: dvc metrics show [-h] [-q | -v] [-a] [-T] [--all-commits]
[--show-json] [--show-md] [-R]
[--json] [--md] [-R]
[targets [targets ...]]
positional arguments:
Expand Down Expand Up @@ -44,10 +44,10 @@ compares them with a previous version.
well as in the workspace. This prints metrics in the entire commit history of
the project.

- `--show-json` - prints the command's output in easily parsable JSON format,
instead of a human-readable table.
- `--json` - prints the command's output in easily parsable JSON format, instead
of a human-readable table.

- `--show-md` - prints the command's output in Markdown table format.
- `--md` - prints the command's output in Markdown table format.

- `-R`, `--recursive` - determines the metrics files to show by searching each
target directory and its subdirectories for `dvc.yaml` files to inspect. If
Expand Down
8 changes: 4 additions & 4 deletions content/docs/command-reference/params/diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ the <abbr>DVC repository</abbr>, or between a commit and the
```usage
usage: dvc params diff [-h] [-q | -v]
[--targets [<paths> [<paths> ...]]] [--all]
[--deps] [--show-json] [--show-md] [--no-path]
[--deps] [--json] [--md] [--no-path]
positional arguments:
a_rev Old Git commit to compare (defaults to HEAD)
Expand Down Expand Up @@ -62,10 +62,10 @@ specified with the `--targets` option.

- `--deps` - include only parameters that are stage dependencies.

- `--show-json` - prints the command's output in easily parsable JSON format,
instead of a human-readable table.
- `--json` - prints the command's output in easily parsable JSON format, instead
of a human-readable table.

- `--show-md` - prints the command's output in the Markdown table format.
- `--md` - prints the command's output in the Markdown table format.

- `-h`, `--help` - prints the usage/help message, and exit.

Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ and remote storage.

```usage
usage: dvc status [-h] [-v] [-j <number>] [-q] [-c] [-r <name>] [-a] [-T]
[--all-commits] [-d] [-R] [--show-json]
[--all-commits] [-d] [-R] [--json]
[targets [targets ...]]
positional arguments:
Expand Down Expand Up @@ -142,8 +142,8 @@ that.
[remote storage](/doc/command-reference/remote) to compare against (see
`dvc remote list`. Implies `--cloud`.

- `--show-json` - prints the command's output in easily parsable JSON format,
instead of a human-readable table.
- `--json` - prints the command's output in easily parsable JSON format, instead
of a human-readable table.

- `-j <number>`, `--jobs <number>` - parallelism level for DVC to access data
from remote storage. This only applies when the `--cloud` option is used, or a
Expand Down

0 comments on commit 9c7def0

Please sign in to comment.