Skip to content

Commit

Permalink
cmd ref: remove mention of RAW metrics
Browse files Browse the repository at this point in the history
to comlpete #1097
  • Loading branch information
jorgeorpinel committed Apr 17, 2020
1 parent 4bf9eea commit f14bf0b
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 17 deletions.
8 changes: 3 additions & 5 deletions content/docs/command-reference/metrics/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,8 @@ the file contains multiple metrics. See the [options](#options) below and
## Options

- `-t <type>`, `--type <type>` - specify a type for the metric file. Accepted
values are: `raw` (default), `json`. It will be saved into the corresponding
DVC-file, and used by `dvc metrics show` to determine how to handle displaying
metrics. `raw` means that no additional parsing is applied, and `--xpath` is
ignored.
values are: `json`. It will be saved into the corresponding DVC-file, and used
by `dvc metrics show` to determine how to handle displaying metrics.

- `-x <path>`, `--xpath <path>` - specify a path within a metric file to get a
specific metric value. Should be used if the metric file contains multiple
Expand Down Expand Up @@ -106,7 +104,7 @@ outs:
path: metrics.json
cache: true
metric:
type: raw
type: json
persist: false
```

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 @@ -46,9 +46,9 @@ They're calculated between two commits (hash, branch, tag, or any
no directories among the `targets`, this option is ignored.

- `-t <type>`, `--type <type>` - specify a type of the metric file. Accepted
values are: `raw` (default), `json`. It will be saved into the corresponding
DVC-file, and used to determine how to handle displaying metrics. See
`dvc metrics show` for more details.
values are: `json`. It will be saved into the corresponding DVC-file, and used
to determine how to handle displaying metrics. See `dvc metrics show` for more
details.

This option will override any `type` and `xpath` values defined in the
corresponding DVC-file. If no `type` is provided or found in the DVC-file, DVC
Expand Down
8 changes: 3 additions & 5 deletions content/docs/command-reference/metrics/modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,9 @@ ERROR: failed to modify metric file settings -
## Options

- `-t <type>`, `--type <type>` - specify a type for the metric file. Accepted
values are: `raw` (default), `json`. It will be saved into the corresponding
DVC-file, and used by `dvc metrics show` and `dvc metrics diff` to determine
how to handle displaying metrics.

`raw` means that no additional parsing is applied, and `--xpath` is ignored.
values are: `json`. It will be saved into the corresponding DVC-file, and used
by `dvc metrics show` and `dvc metrics diff` to determine how to handle
displaying metrics.

- `-x <path>`, `--xpath <path>` - specify a path within a metric file to get a
specific metric value. Should be used if the metric file contains multiple
Expand Down
6 changes: 2 additions & 4 deletions content/docs/command-reference/metrics/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,8 @@ compares them with a previous version.
## Options

- `-t <type>`, `--type <type>` - specify a type for the metric file. Accepted
values are: `raw` (default), `json`. It will be saved into the corresponding
DVC-file, and used to determine how to handle displaying metrics.

`raw` means that no additional parsing is applied, and `--xpath` is ignored.
values are: `json`. It will be saved into the corresponding DVC-file, and used
to determine how to handle displaying metrics.

This option will override `type` and `xpath` defined in the corresponding
DVC-file. If no `type` is provided or found in the DVC-file, DVC will try to
Expand Down

0 comments on commit f14bf0b

Please sign in to comment.