From bfa1d3e1886b26868a18f2be5e86d5dfb83474df Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Mon, 27 Jan 2020 13:43:43 -0600 Subject: [PATCH 01/13] diff/metics diff: update argument descriptions to match https://github.com/iterative/dvc.org/pull/933 --- dvc/command/diff.py | 6 +++--- dvc/command/metrics.py | 10 +++++----- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/dvc/command/diff.py b/dvc/command/diff.py index 7e064adda0..26df3c0d11 100644 --- a/dvc/command/diff.py +++ b/dvc/command/diff.py @@ -157,13 +157,13 @@ def add_parser(subparsers, parent_parser): ), ) diff_parser.add_argument( - "a_ref", help="Git reference from which diff calculates" + "a_ref", help="Git reference from which the diff begins" ) diff_parser.add_argument( "b_ref", help=( - "Git reference until which diff calculates, if omitted " - "diff shows the difference between current HEAD and a_ref" + "Git reference until which the diff ends. " + "If omitted, `HEAD` (latest commit) is used." ), nargs="?", ) diff --git a/dvc/command/metrics.py b/dvc/command/metrics.py index 3438202a9d..054c4d2c97 100644 --- a/dvc/command/metrics.py +++ b/dvc/command/metrics.py @@ -273,7 +273,7 @@ def add_parser(subparsers, parent_parser): metrics_remove_parser.add_argument("path", help="Path to a metric file.") metrics_remove_parser.set_defaults(func=CmdMetricsRemove) - METRICS_DIFF_HELP = "Output metric values." + METRICS_DIFF_HELP = "Calculates the numeric difference between metrics." metrics_diff_parser = metrics_subparsers.add_parser( "diff", parents=[parent_parser], @@ -285,16 +285,16 @@ def add_parser(subparsers, parent_parser): "a_ref", nargs="?", help=( - "Git reference from which diff is calculated. " - "If omitted `HEAD`(latest commit) is used." + "Git reference from which the diff begins. " + "If omitted, `HEAD` (latest commit) is used." ), ) metrics_diff_parser.add_argument( "b_ref", nargs="?", help=( - "Git reference to which diff is calculated. " - "If omitted current working tree is used." + "Git reference until which the diff ends. " + "If omitted, the current workspace is used instead." ), ) metrics_diff_parser.add_argument( From 2430cb5dea9e70154c02c5e0f9302ca896fc81a7 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 29 Jan 2020 00:08:12 -0600 Subject: [PATCH 02/13] diff: remve unused DIFF_HELP --- dvc/command/diff.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/dvc/command/diff.py b/dvc/command/diff.py index 26df3c0d11..e606f692ba 100644 --- a/dvc/command/diff.py +++ b/dvc/command/diff.py @@ -136,15 +136,14 @@ def run(self): def add_parser(subparsers, parent_parser): DIFF_DESCRIPTION = ( - "Show diff of a data file or a directory that is under DVC control.\n" - "Some basic statistics summary, how many files were deleted/changed." + "Show changes between revisions of the DVC repository.\n" + "Summary of how many files were deleted/changed, et al." ) - DIFF_HELP = "Show a diff of a DVC controlled data file or a directory." diff_parser = subparsers.add_parser( "diff", parents=[parent_parser], description=append_doc_link(DIFF_DESCRIPTION, "diff"), - help=DIFF_HELP, + help=DIFF_DESCRIPTION, formatter_class=argparse.RawDescriptionHelpFormatter, ) diff_parser.add_argument( From b10057a1b2ff4b63c00f0ed92cf0c197495180f7 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 29 Jan 2020 00:12:16 -0600 Subject: [PATCH 03/13] metrics diff: update help desc. per iterative/dvc.org/pull/933 --- dvc/command/metrics.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/dvc/command/metrics.py b/dvc/command/metrics.py index 054c4d2c97..0055e4ea98 100644 --- a/dvc/command/metrics.py +++ b/dvc/command/metrics.py @@ -273,7 +273,8 @@ def add_parser(subparsers, parent_parser): metrics_remove_parser.add_argument("path", help="Path to a metric file.") metrics_remove_parser.set_defaults(func=CmdMetricsRemove) - METRICS_DIFF_HELP = "Calculates the numeric difference between metrics." + METRICS_DIFF_HELP = "Show a table of changes between metrics among DVC " + "repository revisions." metrics_diff_parser = metrics_subparsers.add_parser( "diff", parents=[parent_parser], From b3ff72c98382c856457b6349de19b3af6565153f Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 29 Jan 2020 00:21:30 -0600 Subject: [PATCH 04/13] term: review usage of "version" in strings --- dvc/cli.py | 2 +- dvc/output/base.py | 2 +- dvc/state.py | 8 ++++---- dvc/version.py | 4 ++-- tests/func/test_data_cloud.py | 6 +++--- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/dvc/cli.py b/dvc/cli.py index 37d148d7c8..7deb82a709 100644 --- a/dvc/cli.py +++ b/dvc/cli.py @@ -89,7 +89,7 @@ def error(self, message): class VersionAction(argparse.Action): # pragma: no cover # pylint: disable=too-few-public-methods - """Shows dvc version and exits.""" + """Shows DVC version and exits.""" def __call__(self, parser, namespace, values, option_string=None): from dvc import __version__ diff --git a/dvc/output/base.py b/dvc/output/base.py index ee69e30bcd..da0e7de90a 100644 --- a/dvc/output/base.py +++ b/dvc/output/base.py @@ -412,7 +412,7 @@ def get_used_cache(self, **kwargs): if not self.info: logger.warning( "Output '{}'({}) is missing version info. Cache for it will " - "not be collected. Use dvc repro to get your pipeline up to " + "not be collected. Use `dvc repro` to get your pipeline up to " "date.".format(self, self.stage) ) return NamedCache() diff --git a/dvc/state.py b/dvc/state.py index 88e5c81071..6c9106d1e0 100644 --- a/dvc/state.py +++ b/dvc/state.py @@ -23,13 +23,13 @@ class StateVersionTooNewError(DvcException): - """Thrown when dvc version is older than the state database version.""" + """Thrown when DVC version is older than the state database version.""" def __init__(self, dvc_version, expected, actual): super().__init__( - "you are using an old version '{dvc_version}' of dvc that is " - "using state file version '{expected}' which is not compatible " - "with the state file version '{actual}' that is used in this " + "you are using an old version '{dvc_version}' of DVC that is " + "using state file version '{expected}', which is not compatible " + "with the state file version '{actual}', that is used in this " "repo. Please upgrade right now!".format( dvc_version=dvc_version, expected=expected, actual=actual ) diff --git a/dvc/version.py b/dvc/version.py index e3be5a4885..d4bf622aa1 100644 --- a/dvc/version.py +++ b/dvc/version.py @@ -11,7 +11,7 @@ def _generate_version(base_version): - """Generate a version with information about the git repository""" + """Generate a version with information about the Git repository.""" pkg_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) if not _is_git_repo(pkg_dir) or not _have_git(): @@ -28,7 +28,7 @@ def _generate_version(base_version): def _is_git_repo(dir_path): - """Is the given directory version-controlled with git?""" + """Is the given directory version-controlled with Git?""" return os.path.exists(os.path.join(dir_path, ".git")) diff --git a/tests/func/test_data_cloud.py b/tests/func/test_data_cloud.py index fe3aa432f8..f4de706312 100644 --- a/tests/func/test_data_cloud.py +++ b/tests/func/test_data_cloud.py @@ -498,9 +498,9 @@ def _test(self): self._caplog.clear() self.main(["status", "-c"]) expected_warning = ( - "Output 'bar'(Stage: 'bar.dvc') is missing version info." - " Cache for it will not be collected." - " Use dvc repro to get your pipeline up to date." + "Output 'bar'(Stage: 'bar.dvc') is missing version info. " + "Cache for it will not be collected. " + "Use `dvc repro` to get your pipeline up to date." ) assert expected_warning in self._caplog.text From d0139a7826a15c349a38a2d06b05d101c7d97031 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 29 Jan 2020 00:38:41 -0600 Subject: [PATCH 05/13] term: review "revision", "reference", and "hash", "SHA" terms --- dvc/command/gc.py | 6 +++--- dvc/command/get.py | 2 +- dvc/command/imp.py | 2 +- dvc/remote/base.py | 2 +- dvc/scm/git/tree.py | 2 +- dvc/version.py | 2 +- scripts/completion/dvc.zsh | 6 +++--- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/dvc/command/gc.py b/dvc/command/gc.py index 7cbffc537c..2ee4979d5e 100644 --- a/dvc/command/gc.py +++ b/dvc/command/gc.py @@ -52,10 +52,10 @@ def run(self): def add_parser(subparsers, parent_parser): - GC_HELP = "Collect unused data from DVC cache or a remote storage." + GC_HELP = "Garbage collect unused objects from cache or remote storage." GC_DESCRIPTION = ( - "Deletes all files in the cache or a remote which are not in\n" - "use by the specified git references (defaults to just HEAD)." + "Removes all files in the cache or a remote which are not in\n" + "use by the specified Git revisions (defaults to just HEAD)." ) gc_parser = subparsers.add_parser( "gc", diff --git a/dvc/command/get.py b/dvc/command/get.py index e27c178b55..a0bc5186fa 100644 --- a/dvc/command/get.py +++ b/dvc/command/get.py @@ -73,7 +73,7 @@ def add_parser(subparsers, parent_parser): "-o", "--out", nargs="?", help="Destination path to download files to" ) get_parser.add_argument( - "--rev", nargs="?", help="Git revision (e.g. branch, tag, SHA)" + "--rev", nargs="?", help="Git revision (e.g. SHA, branch, tag)" ) get_parser.add_argument( "--show-url", diff --git a/dvc/command/imp.py b/dvc/command/imp.py index 7d095dbd17..83ee0da7bb 100644 --- a/dvc/command/imp.py +++ b/dvc/command/imp.py @@ -53,6 +53,6 @@ def add_parser(subparsers, parent_parser): "-o", "--out", nargs="?", help="Destination path to download files to" ) import_parser.add_argument( - "--rev", nargs="?", help="Git revision (e.g. branch, tag, SHA)" + "--rev", nargs="?", help="Git revision (e.g. SHA, branch, tag)" ) import_parser.set_defaults(func=CmdImport) diff --git a/dvc/remote/base.py b/dvc/remote/base.py index 33ec566bb7..6096af65f4 100644 --- a/dvc/remote/base.py +++ b/dvc/remote/base.py @@ -191,7 +191,7 @@ def _calculate_checksums(self, file_infos): tasks, total=len(file_infos), unit="md5", - desc="Computing hashes (only done once)", + desc="Computing file checksum(s) (only done once)", ) as tasks: checksums = dict(zip(file_infos, tasks)) return checksums diff --git a/dvc/scm/git/tree.py b/dvc/scm/git/tree.py index 776d77c811..7933dee721 100644 --- a/dvc/scm/git/tree.py +++ b/dvc/scm/git/tree.py @@ -102,7 +102,7 @@ def git_object_by_path(self, path): tree = self.git.tree(self.rev) except git.exc.BadName as exc: raise DvcException( - "revision '{}' not found in git '{}'".format( + "revision '{}' not found in Git '{}'".format( self.rev, os.path.relpath(self.git.working_dir) ) ) from exc diff --git a/dvc/version.py b/dvc/version.py index d4bf622aa1..0b2db6be5a 100644 --- a/dvc/version.py +++ b/dvc/version.py @@ -57,7 +57,7 @@ def _is_release(dir_path, base_version): def _git_revision(dir_path): - """Get the SHA-1 of the HEAD of a git repository.""" + """Get SHA of the HEAD of a Git repository.""" return subprocess.check_output( ["git", "rev-parse", "HEAD"], cwd=dir_path ).strip() diff --git a/scripts/completion/dvc.zsh b/scripts/completion/dvc.zsh index 32bdef47ff..6129fce0f6 100644 --- a/scripts/completion/dvc.zsh +++ b/scripts/completion/dvc.zsh @@ -22,7 +22,7 @@ _dvc_commands() { "fetch:Fetch data files from a DVC remote storage." "get-url:Download or copy files from URL." "get:Download data from DVC repository." - "gc:Collect unused data from DVC cache or a remote storage." + "gc:Garbage collect unused objects from cache or remote storage." "import-url:Download or copy file from URL and take it under DVC control." "import:Download data from DVC repository and take it under DVC control." "init:Initialize DVC in the current directory." @@ -117,7 +117,7 @@ _dvc_geturl=( _dvc_get=( {-o,--out}"[Destination path to put data to.]:OUT:_files -/" - "--rev[Git revision (e.g. branch, tag, SHA)]:Revision:" + "--rev[Git revision (e.g. SHA, branch, tag)]:Revision:" "--show-url[Returns path/url to the location in remote for given path]" "1:URL:" "2:Path:" @@ -141,7 +141,7 @@ _dvc_importurl=( _dvc_import=( {-o,--out}"[Destination path to put data to.]:OUT:_files -/" - "--rev[DVC repository git revision.]:Commit hash:" + "--rev[Git revision (e.g. SHA, branch, tag)]:Commit hash:" "1:URL:" "2:Path:" ) From 1672cdfb063fb8971fb92d928b1973bf96d1fb12 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 29 Jan 2020 00:39:46 -0600 Subject: [PATCH 06/13] Update Dmitry's email address ) --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 394dd35787..9f211084cc 100644 --- a/setup.py +++ b/setup.py @@ -133,7 +133,7 @@ def run(self): description="Git for data scientists - manage your code and data together", long_description=open("README.rst", "r").read(), author="Dmitry Petrov", - author_email="dmitry@dataversioncontrol.com", + author_email="dmitry@iterative.ai", download_url="https://github.com/iterative/dvc", license="Apache License 2.0", install_requires=install_requires, From 4403d66ac6f9e4ddfa39ac6ec697823d206e2685 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Thu, 30 Jan 2020 12:24:31 -0600 Subject: [PATCH 07/13] metrics diff: use same param desc as in simple `diff` --- dvc/command/metrics.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/dvc/command/metrics.py b/dvc/command/metrics.py index 0055e4ea98..7aa6e7b7df 100644 --- a/dvc/command/metrics.py +++ b/dvc/command/metrics.py @@ -273,8 +273,8 @@ def add_parser(subparsers, parent_parser): metrics_remove_parser.add_argument("path", help="Path to a metric file.") metrics_remove_parser.set_defaults(func=CmdMetricsRemove) - METRICS_DIFF_HELP = "Show a table of changes between metrics among DVC " - "repository revisions." + METRICS_DIFF_HELP = "Show a table of changes between metrics among " + "versions of the DVC repository." metrics_diff_parser = metrics_subparsers.add_parser( "diff", parents=[parent_parser], @@ -286,16 +286,16 @@ def add_parser(subparsers, parent_parser): "a_ref", nargs="?", help=( - "Git reference from which the diff begins. " - "If omitted, `HEAD` (latest commit) is used." + "Git reference to the older version to compare" + " (defaults to `HEAD`)" ), ) metrics_diff_parser.add_argument( "b_ref", nargs="?", help=( - "Git reference until which the diff ends. " - "If omitted, the current workspace is used instead." + "Git reference to the newer version to compare" + " (defaults to the current workspace including changes)" ), ) metrics_diff_parser.add_argument( From 039f196dd82eb04e47d1292f0a8b00ab0ef52b11 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Thu, 30 Jan 2020 12:25:40 -0600 Subject: [PATCH 08/13] Update Dmitry's email address in several places per https://github.com/iterative/dvc/pull/3244#pullrequestreview-349888033 --- debian/changelog | 2 +- debian/control | 2 +- debian/copyright | 4 ++-- setup.py | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/debian/changelog b/debian/changelog index ebe497cee3..47bb099667 100644 --- a/debian/changelog +++ b/debian/changelog @@ -2,4 +2,4 @@ dvc (0.75.b1) experimental; urgency=low * First native Debian package version. - -- Dmitry Petrov Sat, 07 Dec 2019 09:49:28 +0300 + -- Dmitry Petrov Sat, 07 Dec 2019 09:49:28 +0300 diff --git a/debian/control b/debian/control index 2ddf61df85..6c889e5ec3 100644 --- a/debian/control +++ b/debian/control @@ -1,5 +1,5 @@ Source: dvc -Maintainer: Dmitry Petrov +Maintainer: Dmitry Petrov Section: python Priority: optional Build-Depends: dh-python, python3-setuptools, python3-all, debhelper (>= 9) diff --git a/debian/copyright b/debian/copyright index 523903a1c6..4c34030411 100644 --- a/debian/copyright +++ b/debian/copyright @@ -1,10 +1,10 @@ Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ Upstream-Name: DVC -Upstream-Contact: Dmitry Petrov +Upstream-Contact: Dmitry Petrov Source: https://github.com/iterative/dvc Files: * -Copyright: Dmitry Petrov +Copyright: Dmitry Petrov License: Apache 2.0 On Debian systems, the full text of the Apache 2.0 License can be found in the file diff --git a/setup.py b/setup.py index 9e9b64f42e..a80203a70b 100644 --- a/setup.py +++ b/setup.py @@ -133,7 +133,7 @@ def run(self): description="Git for data scientists - manage your code and data together", long_description=open("README.rst", "r").read(), author="Dmitry Petrov", - author_email="dmitry@iterative.ai", + author_email="dmitry@dvc.org", download_url="https://github.com/iterative/dvc", license="Apache License 2.0", install_requires=install_requires, From 5019fe147cb7a056c84dc669c8bfb894a001ccb0 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Thu, 30 Jan 2020 18:13:36 -0600 Subject: [PATCH 09/13] term: use "hash" instead of "checksum" in a few files per https://github.com/iterative/dvc/pull/3244#pullrequestreview-351108115 --- dvc/command/commit.py | 2 +- dvc/command/diff.py | 2 +- dvc/remote/base.py | 16 ++++++++-------- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/dvc/command/commit.py b/dvc/command/commit.py index b078c899de..b00e46ec44 100644 --- a/dvc/command/commit.py +++ b/dvc/command/commit.py @@ -47,7 +47,7 @@ def add_parser(subparsers, parent_parser): "--force", action="store_true", default=False, - help="Commit even if checksums for dependencies/outputs changed.", + help="Commit even if hash value for dependencies/outputs changed.", ) commit_parser.add_argument( "-d", diff --git a/dvc/command/diff.py b/dvc/command/diff.py index df1f61f27e..1e0edcf6a9 100644 --- a/dvc/command/diff.py +++ b/dvc/command/diff.py @@ -155,7 +155,7 @@ def add_parser(subparsers, parent_parser): ) diff_parser.add_argument( "--checksums", - help="Display checksums for each entry", + help="Display hash value for each entry", action="store_true", default=False, ) diff --git a/dvc/remote/base.py b/dvc/remote/base.py index 33cb8a300e..be5929fd21 100644 --- a/dvc/remote/base.py +++ b/dvc/remote/base.py @@ -66,7 +66,7 @@ class RemoteMissingDepsError(DvcException): class DirCacheError(DvcException): def __init__(self, checksum): super().__init__( - "Failed to load dir cache for checksum: '{}'.".format(checksum) + "Failed to load dir cache for hash value: '{}'.".format(checksum) ) @@ -191,7 +191,7 @@ def _calculate_checksums(self, file_infos): tasks, total=len(file_infos), unit="md5", - desc="Computing file checksum(s) (only done once)", + desc="Computing file/dir hashes (only done once)", ) as tasks: checksums = dict(zip(file_infos, tasks)) return checksums @@ -342,13 +342,13 @@ def changed(self, path_info, checksum_info): A file is considered changed if: - It doesn't exist on the working directory (was unlinked) - - Checksum is not computed (saving a new file) - - The checkusm stored in the State is different from the given one + - Hash value is not computed (saving a new file) + - The hash value stored is different from the given one - There's no file in the cache Args: path_info: dict with path information. - checksum: expected checksum for this data. + checksum: expected hash value for this data. Returns: bool: True if data has changed, False otherwise. @@ -364,7 +364,7 @@ def changed(self, path_info, checksum_info): checksum = checksum_info.get(self.PARAM_CHECKSUM) if checksum is None: - logger.debug("checksum for '{}' is missing.", path_info) + logger.debug("hash value for '{}' is missing.", path_info) return True if self.changed_cache(checksum): @@ -376,7 +376,7 @@ def changed(self, path_info, checksum_info): actual = self.get_checksum(path_info) if checksum != actual: logger.debug( - "checksum '{}'(actual '{}') for '{}' has changed.", + "hash value '{}' for '{}' has changed (actual '{}').", checksum, actual, path_info, @@ -962,7 +962,7 @@ def checkout( skip = False if not checksum: logger.warning( - "No checksum info found for '{}'. " "It won't be created.", + "No file hash info found for '{}'. " "It won't be created.", path_info, ) self.safe_remove(path_info, force=force) From 611c1d600fcf17f5cfe01c2701246d2b866c4dc9 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Thu, 30 Jan 2020 18:23:58 -0600 Subject: [PATCH 10/13] scripts: update autocomplete per diff changes per https://github.com/iterative/dvc/pull/3244#pullrequestreview-351108115 --- scripts/completion/dvc.bash | 3 ++- scripts/completion/dvc.zsh | 5 +++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/scripts/completion/dvc.bash b/scripts/completion/dvc.bash index 8c2d3b0612..08dee22f38 100644 --- a/scripts/completion/dvc.bash +++ b/scripts/completion/dvc.bash @@ -34,9 +34,10 @@ _dvc_install='' _dvc_lock='$(compgen -G *.dvc)' _dvc_metrics='add modify rmeove show' _dvc_metrics_add='-t --type -x --xpath $(compgen -G *)' +_dvc_metrics_show='$(-t --type -x --xpath -a --all-branches -T --all-tags -R --recursive $(compgen -G *)' +_dvc_metrics_diff='--targets -t --type -x --xpath -R --show-json' _dvc_metrics_modify='-t --type -x --xpath $(compgen -G *)' _dvc_metrics_remove='$(compgen -G *)' -_dvc_metrics_show='$(-t --type -x --xpath -a --all-branches -T --all-tags -R --recursive $(compgen -G *)' _dvc_move='$(compgen -G *)' _dvc_pipeline='list show' _dvc_pipeline_list='' diff --git a/scripts/completion/dvc.zsh b/scripts/completion/dvc.zsh index 15c949b28b..0ee883f2d2 100644 --- a/scripts/completion/dvc.zsh +++ b/scripts/completion/dvc.zsh @@ -99,7 +99,8 @@ _dvc_destroy=( _dvc_diff=( "--show-json[Format the output into a JSON]" "--checksums[Display checksums for each entry]" - {1,2}":Git revision (e.g. branch, tag, SHA):" + "1:Git reference to the older version:" + "2:Git reference to the newer version:" ) _dvc_fetch=( @@ -160,7 +161,7 @@ _dvc_lock=( ) _dvc_metrics=( - "1:Sub command:(show add modify remove)" + "1:Sub command:(add show diff modify remove)" ) _dvc_move=( From 6984546ae2ae584a7696922fd060bce3007a5ba1 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Thu, 30 Jan 2020 18:25:11 -0600 Subject: [PATCH 11/13] diff/metrics diff: simplify `b_ref` desc per https://github.com/iterative/dvc/pull/3244#pullrequestreview-351111761 --- dvc/command/diff.py | 8 ++++---- dvc/command/metrics.py | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/dvc/command/diff.py b/dvc/command/diff.py index 1e0edcf6a9..e23fef94fd 100644 --- a/dvc/command/diff.py +++ b/dvc/command/diff.py @@ -133,8 +133,8 @@ def add_parser(subparsers, parent_parser): diff_parser.add_argument( "a_ref", help=( - "Git reference to the older version to compare" - " (defaults to `HEAD`)" + "Git reference to the older version to compare " + "(defaults to `HEAD`)" ), nargs="?", default="HEAD", @@ -142,8 +142,8 @@ def add_parser(subparsers, parent_parser): diff_parser.add_argument( "b_ref", help=( - "Git reference to the newer version to compare" - " (defaults to the current workspace including changes)" + "Git reference to the newer version to compare " + "(defaults to the current workspace)" ), nargs="?", ) diff --git a/dvc/command/metrics.py b/dvc/command/metrics.py index 7aa6e7b7df..e6d92b7392 100644 --- a/dvc/command/metrics.py +++ b/dvc/command/metrics.py @@ -286,16 +286,16 @@ def add_parser(subparsers, parent_parser): "a_ref", nargs="?", help=( - "Git reference to the older version to compare" - " (defaults to `HEAD`)" + "Git reference to the older version to compare " + "(defaults to `HEAD`)" ), ) metrics_diff_parser.add_argument( "b_ref", nargs="?", help=( - "Git reference to the newer version to compare" - " (defaults to the current workspace including changes)" + "Git reference to the newer version to compare " + "(defaults to the current workspace)" ), ) metrics_diff_parser.add_argument( From e70d5fdbc389e5f14e89f045ed67a3d6578b96cc Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Fri, 31 Jan 2020 19:59:57 -0600 Subject: [PATCH 12/13] remove unnecessary line from PR template --- .github/PULL_REQUEST_TEMPLATE.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d9e9858c4d..5582aacbe2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,4 +5,3 @@ * [ ] ❌ Have you checked DeepSource, CodeClimate, and other sanity checks below? We consider their findings recommendatory and don't expect everything to be addressed. Please review them carefully and fix those that actually improve code or fix bugs. Thank you for the contribution - we'll try to review it as soon as possible. 🙏 - From c27f6efa656f084146e48629c3d47acfcb24ba7a Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Fri, 31 Jan 2020 20:03:17 -0600 Subject: [PATCH 13/13] diff: remove backquotes around "HEAD" per https://github.com/iterative/dvc/pull/3244#pullrequestreview-351263562 --- dvc/command/diff.py | 2 +- dvc/command/metrics.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/dvc/command/diff.py b/dvc/command/diff.py index e23fef94fd..68899bb865 100644 --- a/dvc/command/diff.py +++ b/dvc/command/diff.py @@ -134,7 +134,7 @@ def add_parser(subparsers, parent_parser): "a_ref", help=( "Git reference to the older version to compare " - "(defaults to `HEAD`)" + "(defaults to HEAD)" ), nargs="?", default="HEAD", diff --git a/dvc/command/metrics.py b/dvc/command/metrics.py index e6d92b7392..77d28bbf06 100644 --- a/dvc/command/metrics.py +++ b/dvc/command/metrics.py @@ -287,7 +287,7 @@ def add_parser(subparsers, parent_parser): nargs="?", help=( "Git reference to the older version to compare " - "(defaults to `HEAD`)" + "(defaults to HEAD)" ), ) metrics_diff_parser.add_argument(