Apply suggestions from code review

Thanks @sbrl. Will keep grammatical mistakes to minimum next time :smile

Co-authored-by: Starbeamrainbowlabs <sbrl@starbeamrainbowlabs.com>
client-spec/clarity
Puneetha Pai 2020-07-31 20:33:25 +05:30 committed by Starbeamrainbowlabs
parent c6d6d7618c
commit 91e565ba81
11 changed files with 51 additions and 50 deletions

View File

@ -7,14 +7,14 @@
`dvc add {{path/to/file}}`
- Add target directory to the index:
- Add a target directory to the index:
`dvc add {{path/to/directory}}`
- Recursively add all files in target directory:
- Recursively add all the files in a given target directory:
`dvc add --recursive {{path/to/directory}}`
- Add target file with custom .dvc file name:
- Add a target file with a custom `.dvc` filename:
`dvc add --file custom_name.dvc {{path/to/file}}`
`dvc add --file {{custom_name.dvc}} {{path/to/file}}`

View File

@ -3,14 +3,14 @@
> Update data files and directories in the workspace based on current DVC-files.
> More information: <https://dvc.org/doc/command-reference/checkout>.
- Checkout to latest version, for all target files and directories:
- Checkout the latest version of all target files and directories:
`dvc checkout`
- Checkout to latest version, for a given target:
- Checkout to latest version of a specified target:
`dvc checkout {{target}}`
- Checkout specific version of target from different Git commit/tag/branch:
- Checkout a specific version of a target from a different Git commit/tag/branch:
`git checkout {{commit_hash/tag/branch}} {{target}} && dvc checkout {{target}}`
`git checkout {{commit_hash|tag|branch}} {{target}} && dvc checkout {{target}}`

View File

@ -3,11 +3,11 @@
> Record changes to DVC-tracked files in the project.
> More information: <https://dvc.org/doc/command-reference/commit>.
- Commit latest version, for all DVC-tracked files and directories:
- Commit changes to all DVC-tracked files and directories:
`dvc commit`
- Commit latest version, for a given DVC-tracked target:
- Commit changes to a specified DVC-tracked target:
`dvc commit {{target}}`

View File

@ -1,33 +1,33 @@
# dvc config
> Low level command to manage custom configuration options for dvc repositories.
> These configurations can be project/local/global/system level.
> These configurations can be on project, local, global, or system level.
> More information: <https://dvc.org/doc/command-reference/config>.
- Get default remote name:
- Get the name of the default remote:
`dvc config core.remote`
- Set project default remote:
- Set the project's default remote:
`dvc config core.remote {{remote_name}}`
- Unset project default remote:
- Unset the project's default remote:
`dvc config --unset core.remote`
- Get project config value for a key:
- Get the config value for a specified key for the current project:
`dvc config key`
`dvc config {{key}}`
- Set project level config value for a key:
- Set the config value for a key on a project level:
`dvc config key value`
`dvc config {{key}} {{value}}`
- Unset project level config value for a key:
- Unset a project level config value for a given key:
`dvc config --unset key`
`dvc config --unset {{key}}`
- Set local/global/system level config:
- Set a local, global, or system level config value:
`dvc config --local/global/system key value`
`dvc config --local/global/system {{key}} {{value}}`

View File

@ -1,19 +1,19 @@
# dvc dag
> Visualize the pipeline(s) in dvc.yaml.
> Visualize the pipeline(s) defined in `dvc.yaml`.
> More information: <https://dvc.org/doc/command-reference/dag>.
- Visualize entire pipeline:
- Visualize the entire pipeline:
`dvc dag`
- Visualize pipeline stages up to a target stage:
- Visualize the pipeline stages up to a specified target stage:
`dvc dag {{target}}`
- Export pipeline in dot format:
- Export the pipeline in the dot format:
`dvc dag --dot > pipeline.dot`
`dvc dag --dot > {{path/to/pipeline.dot}}`
- Export pipeline as SVG:

View File

@ -3,10 +3,10 @@
> Remove all DVC files and directories from a DVC project.
> More information: <https://dvc.org/doc/command-reference/destroy>.
- Destroy:
- Destroy the current project:
`dvc destroy`
- Force Destroy:
- Force destroy the current project:
`dvc destroy --force`

View File

@ -1,9 +1,9 @@
# dvc diff
> Show changes in DVC tracked file and directories added/deleted/modified.
> Show changes in DVC tracked file and directories.
> More information: <https://dvc.org/doc/command-reference/diff>.
- Compare DVC tracked file from different Git commit/tag/branch w.r.t current workspace:
- Compare DVC tracked files from different Git commits, tags, and branches w.r.t the current workspace:
`dvc diff {{commit_hash/tag/branch}}`
@ -11,14 +11,14 @@
`dvc diff b_rev a_rev`
- Compare DVC tracked file, along with their latest hash:
- Compare DVC tracked files, along with their latest hash:
`dvc diff --show-hash {{commit}}`
- Compare DVC tracked file, get output in JSON format:
- Compare DVC tracked files, displaying the output as JSON:
`dvc diff --show-json --show-hash {{commit}}`
- Compare DVC tracked file, get output in Markdown format:
- Compare DVC tracked files, displaying the output as Markdown:
`dvc diff --show-md --show-hash {{commit}}`

View File

@ -4,9 +4,9 @@
> This makes DVC to stop tracking changes in stage dependencies and re-execution untill unfreeze.
> More information: <https://dvc.org/doc/command-reference/freeze>.
- Freeze given stage/s:
- Freeze 1 or more specified stages:
`dvc freeze {{stage_name/s}}`
`dvc freeze {{stage_name_a}} [{{stage_name_b}} ...]`
- Unfreeze given stage/s:

View File

@ -1,20 +1,20 @@
# dvc gc
> Remove unused files and directories from cache or remote storage.
> Remove unused files and directories from the cache or remote storage.
> More information: <https://dvc.org/doc/command-reference/gc>.
- Garbage collect from cache, keeping only version referenced by current workspace:
- Garbage collect from the cache, keeping only versions referenced by the current workspace:
`dvc gc --workspace`
- Garbage collect from cache, keeping only version referenced by branch/tags/all_commits:
- Garbage collect from the cache, keeping only versions referenced by branch, tags, and commits:
`dvc gc --all-branches --all-tags --all-commits`
- Garbage collect from cache, including default cloud remote storage (if set):
- Garbage collect from the cache, including the default cloud remote storage (if set):
`dvc gc --all-commits --cloud`
- Garbage collect from cache, including specific cloud remote storage:
- Garbage collect from the cache, including a specific cloud remote storage:
`dvc gc --all-commits --cloud -r {{remote_name}}`

View File

@ -1,12 +1,13 @@
# dvc unfreeze
> Unfreeze stages in DVC pipeline.
> This makes DVC to start tracking changes in stage dependencies again after they were frozen.
> Unfreeze stages in the DVC pipeline.
> This allows DVC to start tracking changes in stage dependencies again after they were frozen.
> See also `dvc freeze`.
> More information: <https://dvc.org/doc/command-reference/unfreeze>.
- Unfreeze given stage/s:
`dvc unfreeze {{stage_name/s}}`
`dvc unfreeze {{stage_name_a}} [{{stage_name_b}} ...]`
- Freeze given stage/s:

View File

@ -1,20 +1,20 @@
# dvc
> Data Version Control i.e git for data.
> Data Version Control: like `git` for data.
> More information: <https://dvc.org/>.
- Check the DVC version:
`dvc --version`
- Call general help:
- Display general help:
`dvc --help`
- Call help on a command:
- Display help about a specific subcommand:
`dvc {{command}} --help`
`dvc {{subcommand}} --help`
- Execute DVC command:
- Execute a DVC subcommand:
`dvc {{command}}`
`dvc {{subcommand}}`