Skip to content

Commit 2615671

Browse files
committed
cmd ref: standart use or prereqs in all cmd options
per previous 2 commits
1 parent cab347c commit 2615671

File tree

9 files changed

+30
-33
lines changed

9 files changed

+30
-33
lines changed

public/static/docs/command-reference/add.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -87,11 +87,11 @@ reproducible.
8787

8888
## Options
8989

90-
- `-R`, `--recursive` - `targets` is expected to contain one or more directories
91-
for this option to have effect. Determines the files to add by searching each
92-
target directory and its subdirectories for data files. For each file found, a
93-
new DVC-file is created using the process described in this command's
94-
description.
90+
- `-R`, `--recursive` - determines the files to add by searching each target
91+
directory and its subdirectories for data files. For each file found, a new
92+
DVC-file is created using the process described in this command's description.
93+
`targets` is expected to contain one or more directories for this option to
94+
have effect.
9595

9696
- `--no-commit` - do not save outputs to cache. A DVC-file is created, and an
9797
entry is added to `.dvc/state`, while nothing is added to the cache. (The

public/static/docs/command-reference/fetch.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,9 @@ specified in DVC-files currently in the project are considered by `dvc fetch`
8484
searches backward from the target stages in the corresponding pipelines. This
8585
means DVC will not fetch files referenced in later stages than the `targets`.
8686

87-
- `-R`, `--recursive` - `targets` is expected to contain one or more directories
88-
for this option to have effect. Determines the files to fetch by searching
89-
each target directory and its subdirectories for DVC-files to inspect.
87+
- `-R`, `--recursive` - determines the files to fetch by searching each target
88+
directory and its subdirectories for DVC-files to inspect. `targets` is
89+
expected to contain one or more directories for this option to have effect.
9090

9191
- `-j JOBS`, `--jobs JOBS` - number of threads to run simultaneously to handle
9292
the downloading of files from the remote. Using more jobs may improve the

public/static/docs/command-reference/get.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ name.
6666

6767
- `--show-url` - instead of downloading the file or directory, just print the
6868
storage location (URL) of the target data. `path` is expected to represent a
69-
cached, DVC-tracked file for this option to have an effect.
69+
cached, DVC-tracked file for this option to have effect.
7070

7171
- `-h`, `--help` - prints the usage/help message, and exit.
7272

public/static/docs/command-reference/import.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,7 @@ data artifact from the source project.
7575
an existing directory is specified, then the output will be placed inside of
7676
it.
7777

78-
- `--rev` - `url` is expected to represent a Git repository for this option to
79-
have an effect. Specific
78+
- `--rev` - specific
8079
[Git revision](https://git-scm.com/book/en/v2/Git-Internals-Git-References)
8180
(such as a branch name, a tag, or a commit hash) of the repository to download
8281
the file or directory from. The tip of the default branch is used by default

public/static/docs/command-reference/metrics/show.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,9 @@ extension.)
8989
Similar to `-a` above. Note that both options can be combined, for example
9090
using the `-aT` flag.
9191

92-
- `-R`, `--recursive` - `targets` is expected to contain one or more directories
93-
for this option to have effect. Determines the metric files to show by
94-
searching each target directory and its subdirectories for DVC-files to
95-
inspect.
92+
- `-R`, `--recursive` - determines the metric files to show by searching each
93+
target directory and its subdirectories for DVC-files to inspect. `targets` is
94+
expected to contain one or more directories for this option to have effect.
9695

9796
- `-h`, `--help` - prints the usage/help message, and exit.
9897

public/static/docs/command-reference/pull.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,9 @@ reflinks or hardlinks to put it in the workspace without copying. See
7878
searches backward from the target stages in the corresponding pipelines. This
7979
means DVC will not pull files referenced in later stages than the `targets`.
8080

81-
- `-R`, `--recursive` - `targets` is expected to contain one or more directories
82-
for this option to have effect. Determines the files to pull by searching each
83-
target directory and its subdirectories for DVC-files to inspect.
81+
- `-R`, `--recursive` - determines the metric files to show by searching each
82+
target directory and its subdirectories for DVC-files to inspect. `targets` is
83+
expected to contain one or more directories for this option to have effect.
8484

8585
- `-f`, `--force` - does not prompt when removing workspace files, which occurs
8686
when these file no longer match the current DVC-file references. This option

public/static/docs/command-reference/push.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ to push.
8787
searches backward from the target stages in the corresponding pipelines. This
8888
means DVC will not push files referenced in later stages than the `targets`.
8989

90-
- `-R`, `--recursive` - `targets` is expected to contain one or more directories
91-
for this option to have effect. Determines the files to push by searching each
92-
target directory and its subdirectories for DVC-files to inspect.
90+
- `-R`, `--recursive` - determines the metric files to show by searching each
91+
target directory and its subdirectories for DVC-files to inspect. `targets` is
92+
expected to contain one or more directories for this option to have effect.
9393

9494
- `-j JOBS`, `--jobs JOBS` - specifies number of jobs to run simultaneously
9595
while uploading files to the remote. The effect is to control the number of

public/static/docs/command-reference/repro.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -95,10 +95,9 @@ and only execute the final stage.
9595
reproduced as part of the pipeline in the parent directory, or as an
9696
independent unit.
9797

98-
- `-R`, `--recursive` - `targets` is expected to contain one or more directories
99-
for this option to have effect. Determines the stages to reproduce by
100-
searching each target directory and its subdirectories for DVC-files to
101-
inspect.
98+
- `-R`, `--recursive` - determines the stages to reproduce by searching each
99+
target directory and its subdirectories for DVC-files to inspect. `targets` is
100+
expected to contain one or more directories for this option to have effect.
102101

103102
- `--no-commit` - do not save outputs to cache. (See `dvc run`.) Useful when
104103
running different experiments and you don't want to fill up the cache with

public/static/docs/command-reference/run.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -142,14 +142,14 @@ data pipeline (e.g. random numbers, time functions, hardware dependency, etc.)
142142
determined by the logic described in the `-f` option) without asking for
143143
confirmation.
144144

145-
- `--ignore-build-cache` - This options has an effect if an equivalent stage
146-
file exists (same dependencies, outputs, and `command` to execute), that has
147-
been already executed, and is up to date. In this case, `dvc run` won't
148-
normally execute the `command` again. The exception is when the existing stage
149-
is considered always changed (see `--always-changed` option). This option
150-
gives a way to forcefully execute the `command` anyway. Useful if the
151-
command's code is non-deterministic (meaning it produces different outputs
152-
from the same list of inputs).
145+
- `--ignore-build-cache` - has an effect if an equivalent stage file exists
146+
(same dependencies, outputs, and `command` to execute), that has been already
147+
executed, and is up to date. In this case, `dvc run` won't normally execute
148+
the `command` again. The exception is when the existing stage is considered
149+
always changed (see `--always-changed` option). This option gives a way to
150+
forcefully execute the `command` anyway. Useful if the command's code is
151+
non-deterministic (meaning it produces different outputs from the same list of
152+
inputs).
153153

154154
- `--remove-outs` (_deprecated_) - remove stage outputs before executing the
155155
`command`. If `--no-exec` specified outputs are removed anyway. See

0 commit comments

Comments
 (0)