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

Jump to bottom

Regular updates (Apr 16) #1160

Merged
merged 3 commits into from
Apr 21, 2020
Merged

Regular updates (Apr 16) #1160

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4bf9eea
user-guide: remove link-check script from contrib guide
jorgeorpinel Apr 16, 2020
f14bf0b
cmd ref: remove mention of RAW metrics
jorgeorpinel Apr 17, 2020
55e9488
cmd ref: add --summary to checkout
jorgeorpinel Apr 17, 2020
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
8 changes: 3 additions & 5 deletions content/docs/command-reference/metrics/add.md
View file
Open in desktop
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
Comment on lines -109 to +107
Copy link
Contributor Author

@jorgeorpinel jorgeorpinel Apr 17, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is correct right @dmpetrov? See https://dvc.org/doc/command-reference/metrics/add#examples

I'm also removing all mentions of raw type metrics, per iterative/dvc#3626 (review).

persist: false
```

Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/metrics/diff.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
5 changes: 0 additions & 5 deletions content/docs/user-guide/contributing/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,11 +118,6 @@ and detect different errors:
- `yarn lint-ts` - lint source code files (`.ts`, `.js`, `tsx`, etc).
- `yarn lint-css` - lint `.css` files.

Other checks:

- `yarn link-check` - runs script to detect broken URLs (e.g. those that return
404 - Not Found) in the content.

### ENV variables

Some environment variables are required to deploy this project to production,
Expand Down