Skip to content
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

Restyle Document short aliases --csv/--json/--md flags #2878

Merged
merged 1 commit into from
Oct 1, 2021
Merged

Restyle Document short aliases --csv/--json/--md flags #2878

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions content/docs/command-reference/diff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 `--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,8 +56,8 @@ for example when `dvc init` was used with the `--no-scm` option.
$ dvc diff --targets t1.json t2.yaml -- HEAD v1
```

- `--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.

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

Expand Down
4 changes: 2 additions & 2 deletions content/docs/command-reference/exp/diff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ all the current experiments (without comparisons).

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

- `--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.

- `--md` - prints the command's output in the Markdown table format
([GFM](https://github.github.com/gfm/#tables-extension-)).
Expand Down
4 changes: 2 additions & 2 deletions content/docs/command-reference/exp/show.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ metric or param.
- `--sha` - display Git commit (SHA) hashes instead of branch, tag, or
experiment names.

- `--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.

- `--csv` - prints the command's output in CSV format instead of a
human-readable table.
Expand Down
4 changes: 2 additions & 2 deletions content/docs/command-reference/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,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.
- `--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
4 changes: 2 additions & 2 deletions content/docs/command-reference/metrics/show.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ compares them with a previous version.
well as in the workspace. This prints metrics in the entire commit history of
the project.

- `--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.

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

Expand Down
4 changes: 2 additions & 2 deletions content/docs/command-reference/params/diff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ specified with the `--targets` option.

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

- `--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.

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

Expand Down
4 changes: 2 additions & 2 deletions content/docs/command-reference/status.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,8 @@ that.
[remote storage](/doc/command-reference/remote) to compare against (see
`dvc remote list`. Implies `--cloud`.

- `--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