From 7f458f96c178e0c3caeff0d12128d46125fa7eee Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Mon, 6 Apr 2020 10:12:08 -0500 Subject: [PATCH 1/2] diff: update help output to match docs per https://github.com/iterative/dvc/pull/3566#pullrequestreview-388346350 --- dvc/command/diff.py | 5 ++--- scripts/completion/dvc.zsh | 2 +- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/dvc/command/diff.py b/dvc/command/diff.py index c907fc0dff..c754c1c586 100644 --- a/dvc/command/diff.py +++ b/dvc/command/diff.py @@ -120,9 +120,8 @@ def run(self): def add_parser(subparsers, parent_parser): DIFF_DESCRIPTION = ( - "Show changes between commits in the DVC repository," - " or between a commit and the workspace. " - "Prints the list of paths added, modified, or deleted." + "Show added, modified, or deleted data between commits in the DVC" + " repository, or between a commit and the workspace." ) diff_parser = subparsers.add_parser( "diff", diff --git a/scripts/completion/dvc.zsh b/scripts/completion/dvc.zsh index 2f4bf6393c..3ed1a56eaa 100644 --- a/scripts/completion/dvc.zsh +++ b/scripts/completion/dvc.zsh @@ -18,7 +18,7 @@ _dvc_commands() { "commit:Save changed data to cache and update DVC-files." "config:Get or set config settings." "destroy:Remove DVC-files, local DVC config and data cache." - "diff:Show changes between commits in the DVC repository, or between a commit and the workspace." + "diff:Show added, modified, or deleted data between commits in the DVC repository, or between a commit and the workspace." "fetch:Get files or directories tracked by DVC from remote storage into the cache." "get-url:Download or copy files from URL." "get:Download data from DVC repository." From 7d8046ac6286fa89be60e2821c054115b93a12b4 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Tue, 7 Apr 2020 02:12:12 -0500 Subject: [PATCH 2/2] terms: git->Git, scm->SCM, spacing --- dvc/command/init.py | 2 +- dvc/output/base.py | 2 +- dvc/scm/__init__.py | 2 +- dvc/scm/base.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/dvc/command/init.py b/dvc/command/init.py index 03821eec3d..4ca6ca50bd 100644 --- a/dvc/command/init.py +++ b/dvc/command/init.py @@ -47,7 +47,7 @@ def add_parser(subparsers, parent_parser): action="store_true", default=False, help="Initiate DVC in directory that is " - "not tracked by any scm tool (e.g. git).", + "not tracked by any SCM tool (e.g. Git).", ) init_parser.add_argument( "-f", diff --git a/dvc/output/base.py b/dvc/output/base.py index f6f7856de5..573f7f06a6 100644 --- a/dvc/output/base.py +++ b/dvc/output/base.py @@ -28,7 +28,7 @@ def __init__(self, path): class OutputAlreadyTrackedError(DvcException): def __init__(self, path): - msg = "output '{}' is already tracked by scm (e.g. git)".format(path) + msg = "output '{}' is already tracked by SCM (e.g. Git)".format(path) super().__init__(msg) diff --git a/dvc/scm/__init__.py b/dvc/scm/__init__.py index 15a75796ff..dbf524cc76 100644 --- a/dvc/scm/__init__.py +++ b/dvc/scm/__init__.py @@ -1,4 +1,4 @@ -"""Manages source control systems(e.g. Git).""" +"""Manages source control systems (e.g. Git).""" from dvc.scm.base import Base from dvc.scm.git import Git diff --git a/dvc/scm/base.py b/dvc/scm/base.py index 0806b25e1e..017263de12 100644 --- a/dvc/scm/base.py +++ b/dvc/scm/base.py @@ -1,4 +1,4 @@ -"""Manages source control systems(e.g. Git) in dvc.""" +"""Manages source control systems (e.g. Git) in DVC.""" import os