diff --git a/content/docs/command-reference/checkout.md b/content/docs/command-reference/checkout.md index c61d8520a6..b469eddef7 100644 --- a/content/docs/command-reference/checkout.md +++ b/content/docs/command-reference/checkout.md @@ -6,8 +6,8 @@ DVC-files. ## Synopsis ```usage -usage: dvc checkout [-h] [-q | -v] [-d] [-R] [-f] [--relink] - [targets [targets ...]] +usage: dvc checkout [-h] [-q | -v] [--summary] [-d] [-R] [-f] + [--relink] [targets [targets ...]] positional arguments: targets DVC-files to checkout. Optional. (Finds all @@ -69,16 +69,18 @@ be pulled from remote storage using `dvc pull`. ## Options +- `--summary` - show summary of the changes. + +- `-R`, `--recursive` - determines the files to checkout by searching each + target directory and its subdirectories for DVC-files to inspect. If there are + no directories among the `targets`, this option is ignored. + - `-d`, `--with-deps` - determines files to update by tracking dependencies to the target DVC-files (stages). If no `targets` are provided, this option is ignored. By traversing all stage dependencies, DVC searches backward from the target stages in the corresponding pipelines. This means DVC will not checkout files referenced in later stages than the `targets`. -- `-R`, `--recursive` - determines the files to checkout by searching each - target directory and its subdirectories for DVC-files to inspect. If there are - no directories among the `targets`, this option is ignored. - - `-f`, `--force` - does not prompt when removing workspace files. Changing the current set of DVC-files with `git checkout` can result in the need for DVC to remove files that don't match those DVC-file references or are missing from diff --git a/content/docs/command-reference/metrics/add.md b/content/docs/command-reference/metrics/add.md index dc20400374..329a58426c 100644 --- a/content/docs/command-reference/metrics/add.md +++ b/content/docs/command-reference/metrics/add.md @@ -31,10 +31,8 @@ the file contains multiple metrics. See the [options](#options) below and ## Options - `-t `, `--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 `, `--xpath ` - specify a path within a metric file to get a specific metric value. Should be used if the metric file contains multiple @@ -106,7 +104,7 @@ outs: path: metrics.json cache: true metric: - type: raw + type: json persist: false ``` diff --git a/content/docs/command-reference/metrics/diff.md b/content/docs/command-reference/metrics/diff.md index 1ed300013d..9772c5e262 100644 --- a/content/docs/command-reference/metrics/diff.md +++ b/content/docs/command-reference/metrics/diff.md @@ -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 ` - 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 diff --git a/content/docs/command-reference/metrics/modify.md b/content/docs/command-reference/metrics/modify.md index 0a3e3bb19a..ae3cae62d0 100644 --- a/content/docs/command-reference/metrics/modify.md +++ b/content/docs/command-reference/metrics/modify.md @@ -33,11 +33,9 @@ ERROR: failed to modify metric file settings - ## Options - `-t `, `--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 `, `--xpath ` - specify a path within a metric file to get a specific metric value. Should be used if the metric file contains multiple diff --git a/content/docs/command-reference/metrics/show.md b/content/docs/command-reference/metrics/show.md index e0c59595e6..81021961ac 100644 --- a/content/docs/command-reference/metrics/show.md +++ b/content/docs/command-reference/metrics/show.md @@ -44,10 +44,8 @@ compares them with a previous version. ## Options - `-t `, `--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 diff --git a/content/docs/user-guide/contributing/docs.md b/content/docs/user-guide/contributing/docs.md index adee343d3c..078c0b2219 100644 --- a/content/docs/user-guide/contributing/docs.md +++ b/content/docs/user-guide/contributing/docs.md @@ -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,