Skip to content

document plots diff/show --open flag #2293

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
shcheklein merged 1 commit into from
Mar 13, 2021
Merged

document plots diff/show --open flag #2293

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
4 changes: 3 additions & 1 deletion content/docs/command-reference/plots/diff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ usage: dvc plots diff [-h] [-q | -v]
[-t <name_or_path>] [-x <field>] [-y <field>]
[--no-header] [--title <text>]
[--x-label <text>] [--y-label <text>] [-o <path>]
[--show-vega]
[--show-vega] [--open]
[revisions [revisions ...]]

positional arguments:
Expand Down Expand Up @@ -91,6 +91,8 @@ all the current plots, without comparisons.
[Vega specification](https://vega.github.io/vega/docs/specification/) file
instead of HTML. See `dvc plots` for more info.

- `--open` - opens the generated plot directly in the browser.

- `--no-header` - lets DVC know that CSV or TSV `--targets` do not have a
header. A 0-based numeric index can be used to identify each column instead of
names.
Expand Down
4 changes: 3 additions & 1 deletion content/docs/command-reference/plots/show.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Generate [plot](/doc/command-reference/plots) from a metrics file.
usage: dvc plots show [-h] [-q | -v] [-t <name_or_path>] [-x <field>]
[-y <field>] [--no-header] [--title <text>]
[--x-label <text>] [--y-label <text>] [-o <path>]
[--show-vega]
[--show-vega] [--open]
[targets [targets ...]]

positional arguments:
Expand Down Expand Up @@ -65,6 +65,8 @@ please see `dvc plots`.
[Vega specification](https://vega.github.io/vega/docs/specification/) file
instead of HTML. See `dvc plots` for more info.

- `--open` - opens the generated plot directly in the browser.

- `--no-header` - lets DVC know that CSV or TSV `targets` do not have a header.
A 0-based numeric index can be used to identify each column instead of names.

Expand Down