From 8b2dca09dcfda081b449202ed6a749319ed84206 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Fri, 28 Feb 2020 00:49:05 -0600 Subject: [PATCH 01/11] metrics show: update -h output to match docs per https://github.com/iterative/dvc.org/pull/1014/commits/2c3452119545987f77b764e4aa6fc94d051092a7 --- dvc/command/metrics.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/dvc/command/metrics.py b/dvc/command/metrics.py index 6cb3887fd7..038e2f2669 100644 --- a/dvc/command/metrics.py +++ b/dvc/command/metrics.py @@ -187,8 +187,7 @@ def add_parser(subparsers, parent_parser): metrics_show_parser.add_argument( "targets", nargs="*", - help="Metric files or directories (see -R) to show " - "(leave empty to display all)", + help="Metric files or directories (see -R) to show", ) metrics_show_parser.add_argument( "-t", From fb139ffc2519ea056c777be21d8a38fdd99181d9 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Tue, 10 Mar 2020 15:19:25 -0500 Subject: [PATCH 02/11] metric: update argument desc per iterative/dvc.org/pull/1014 --- dvc/command/metrics.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dvc/command/metrics.py b/dvc/command/metrics.py index 038e2f2669..14b93b8a68 100644 --- a/dvc/command/metrics.py +++ b/dvc/command/metrics.py @@ -244,7 +244,7 @@ def add_parser(subparsers, parent_parser): metrics_add_parser.add_argument("path", help="Path to a metric file.") metrics_add_parser.set_defaults(func=CmdMetricsAdd) - METRICS_MODIFY_HELP = "Modify metric file options." + METRICS_MODIFY_HELP = "Modify metric file values." metrics_modify_parser = metrics_subparsers.add_parser( "modify", parents=[parent_parser], From 5c4f4ad59edcb590d488188dd64db43c085d6ac0 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 11 Mar 2020 11:41:27 -0600 Subject: [PATCH 03/11] metrics: match iterative/dvc.org/pull/1014 again... using term "formatting" instead of "options" --- dvc/command/metrics.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/dvc/command/metrics.py b/dvc/command/metrics.py index 14b93b8a68..bc4b014f26 100644 --- a/dvc/command/metrics.py +++ b/dvc/command/metrics.py @@ -159,7 +159,7 @@ def run(self): def add_parser(subparsers, parent_parser): - METRICS_HELP = "Commands to add, manage, collect and display metrics." + METRICS_HELP = "Commands to add, manage, collect, and display metrics." metrics_parser = subparsers.add_parser( "metrics", @@ -176,7 +176,7 @@ def add_parser(subparsers, parent_parser): fix_subparsers(metrics_subparsers) - METRICS_SHOW_HELP = "Output metric values." + METRICS_SHOW_HELP = "Print metrics, with optional formatting." metrics_show_parser = metrics_subparsers.add_parser( "show", parents=[parent_parser], @@ -227,7 +227,7 @@ def add_parser(subparsers, parent_parser): ) metrics_show_parser.set_defaults(func=CmdMetricsShow) - METRICS_ADD_HELP = "Tag file as a metric file." + METRICS_ADD_HELP = "Mark output file as a metric." metrics_add_parser = metrics_subparsers.add_parser( "add", parents=[parent_parser], @@ -244,7 +244,7 @@ def add_parser(subparsers, parent_parser): metrics_add_parser.add_argument("path", help="Path to a metric file.") metrics_add_parser.set_defaults(func=CmdMetricsAdd) - METRICS_MODIFY_HELP = "Modify metric file values." + METRICS_MODIFY_HELP = "Modify metric default formatting." metrics_modify_parser = metrics_subparsers.add_parser( "modify", parents=[parent_parser], @@ -261,7 +261,7 @@ def add_parser(subparsers, parent_parser): metrics_modify_parser.add_argument("path", help="Path to a metric file.") metrics_modify_parser.set_defaults(func=CmdMetricsModify) - METRICS_REMOVE_HELP = "Remove files's metric tag." + METRICS_REMOVE_HELP = "Stop tracking a metric file." metrics_remove_parser = metrics_subparsers.add_parser( "remove", parents=[parent_parser], From e3c087edf2442e68f38f2ed35efcfe36f2879321 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 11 Mar 2020 18:28:14 -0600 Subject: [PATCH 04/11] list: update help output to match iterative/dvc.org/pull/1014 That's iterative/dvc.org/pull/1014 --- dvc/command/ls.py | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/dvc/command/ls.py b/dvc/command/ls.py index 37c857241f..a6c41ff88c 100644 --- a/dvc/command/ls.py +++ b/dvc/command/ls.py @@ -39,14 +39,12 @@ def add_parser(subparsers, parent_parser): formatter_class=argparse.RawTextHelpFormatter, ) list_parser.add_argument( - "url", - help="Supported urls:\n" - "/path/to/file\n" - "/path/to/directory\n" - "C:\\\\path\\to\\file\n" - "C:\\\\path\\to\\directory\n" - "https://github.com/path/to/repo\n" - "git@github.com:path/to/repo.git\n", + "url", help="Location of DVC or Git repository to download from" + ) + list_parser.add_argument( + "target", + nargs="?", + help="Path to directory within the repository to list outputs for", ) list_parser.add_argument( "-R", @@ -60,9 +58,4 @@ def add_parser(subparsers, parent_parser): list_parser.add_argument( "--rev", nargs="?", help="Git revision (e.g. branch, tag, SHA)" ) - list_parser.add_argument( - "target", - nargs="?", - help="Path to directory within the repository to list outputs for", - ) list_parser.set_defaults(func=CmdList) From 1a970c6256d57228eee95dfc393bf2f205248e11 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 11 Mar 2020 18:29:29 -0600 Subject: [PATCH 05/11] dvc: add docstring to open_by_relpath It's a public fn after all. Similar to Repo class --- dvc/external_repo.py | 1 + 1 file changed, 1 insertion(+) diff --git a/dvc/external_repo.py b/dvc/external_repo.py index c16d55b584..362d686f93 100644 --- a/dvc/external_repo.py +++ b/dvc/external_repo.py @@ -182,6 +182,7 @@ def pull_to(self, path, to_info): @contextmanager def open_by_relpath(self, path, mode="r", encoding=None, **kwargs): + """Opens a specified resource as a file descriptor""" try: abs_path = os.path.join(self.root_dir, path) with open(abs_path, mode, encoding=encoding) as fd: From f5cda0d33bb4640f2fc94c3d5e05379da8e29c24 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 11 Mar 2020 19:03:26 -0600 Subject: [PATCH 06/11] help: update cmd output strings to match with docs --- dvc/command/data_sync.py | 7 +++---- dvc/command/pipeline.py | 4 ++-- dvc/command/remote.py | 10 +++++----- dvc/command/remove.py | 2 +- dvc/command/repro.py | 3 ++- dvc/command/root.py | 2 +- dvc/command/version.py | 3 ++- 7 files changed, 16 insertions(+), 15 deletions(-) diff --git a/dvc/command/data_sync.py b/dvc/command/data_sync.py index c12b1afcac..b202baa24f 100644 --- a/dvc/command/data_sync.py +++ b/dvc/command/data_sync.py @@ -98,7 +98,7 @@ def add_parser(subparsers, _parent_parser): from dvc.command.status import CmdDataStatus # Pull - PULL_HELP = "Pull data files from a DVC remote storage." + PULL_HELP = "Download tracked files or directories from remote storage." pull_parser = subparsers.add_parser( "pull", @@ -148,8 +148,7 @@ def add_parser(subparsers, _parent_parser): pull_parser.set_defaults(func=CmdDataPull) # Push - PUSH_HELP = "Uploads files or directories tracked by DVC" - " to remote storage." + PUSH_HELP = "Upload tracked files or directories to remote storage." push_parser = subparsers.add_parser( "push", @@ -192,7 +191,7 @@ def add_parser(subparsers, _parent_parser): push_parser.set_defaults(func=CmdDataPush) # Fetch - FETCH_HELP = "Get files or directories tracked by DVC from remote storage" + FETCH_HELP = "Get tracked files or directories from remote storage" " into the cache." fetch_parser = subparsers.add_parser( diff --git a/dvc/command/pipeline.py b/dvc/command/pipeline.py index d5b7dbe86e..c9c26fc1f1 100644 --- a/dvc/command/pipeline.py +++ b/dvc/command/pipeline.py @@ -180,7 +180,7 @@ def add_parser(subparsers, parent_parser): fix_subparsers(pipeline_subparsers) - PIPELINE_SHOW_HELP = "Show pipelines." + PIPELINE_SHOW_HELP = "Show stages in a pipeline." pipeline_show_parser = pipeline_subparsers.add_parser( "show", parents=[parent_parser], @@ -236,7 +236,7 @@ def add_parser(subparsers, parent_parser): ) pipeline_show_parser.set_defaults(func=CmdPipelineShow) - PIPELINE_LIST_HELP = "List pipelines." + PIPELINE_LIST_HELP = "List connected groups of stages (pipelines)." pipeline_list_parser = pipeline_subparsers.add_parser( "list", parents=[parent_parser], diff --git a/dvc/command/remote.py b/dvc/command/remote.py index 364ee7db67..1e352510cb 100644 --- a/dvc/command/remote.py +++ b/dvc/command/remote.py @@ -116,7 +116,7 @@ def add_parser(subparsers, parent_parser): fix_subparsers(remote_subparsers) - REMOTE_ADD_HELP = "Add remote." + REMOTE_ADD_HELP = "Add a new data remote." remote_add_parser = remote_subparsers.add_parser( "add", parents=[parent_config_parser, parent_parser], @@ -147,7 +147,7 @@ def add_parser(subparsers, parent_parser): ) remote_add_parser.set_defaults(func=CmdRemoteAdd) - REMOTE_DEFAULT_HELP = "Set/unset default remote." + REMOTE_DEFAULT_HELP = "Set/unset the default data remote." remote_default_parser = remote_subparsers.add_parser( "default", parents=[parent_config_parser, parent_parser], @@ -167,7 +167,7 @@ def add_parser(subparsers, parent_parser): ) remote_default_parser.set_defaults(func=CmdRemoteDefault) - REMOTE_REMOVE_HELP = "Remove remote." + REMOTE_REMOVE_HELP = "Remove a data remote." remote_remove_parser = remote_subparsers.add_parser( "remove", parents=[parent_config_parser, parent_parser], @@ -180,7 +180,7 @@ def add_parser(subparsers, parent_parser): ) remote_remove_parser.set_defaults(func=CmdRemoteRemove) - REMOTE_MODIFY_HELP = "Modify remote." + REMOTE_MODIFY_HELP = "Modify the configuration of a data remote." remote_modify_parser = remote_subparsers.add_parser( "modify", parents=[parent_config_parser, parent_parser], @@ -204,7 +204,7 @@ def add_parser(subparsers, parent_parser): ) remote_modify_parser.set_defaults(func=CmdRemoteModify) - REMOTE_LIST_HELP = "List available remotes." + REMOTE_LIST_HELP = "List all available data remotes." remote_list_parser = remote_subparsers.add_parser( "list", parents=[parent_config_parser, parent_parser], diff --git a/dvc/command/remove.py b/dvc/command/remove.py index f93b4d2657..d80c029ddb 100644 --- a/dvc/command/remove.py +++ b/dvc/command/remove.py @@ -42,7 +42,7 @@ def run(self): def add_parser(subparsers, parent_parser): - REMOVE_HELP = "Remove DVC-file outputs." + REMOVE_HELP = "Remove data files or directories tracked by DVC." remove_parser = subparsers.add_parser( "remove", parents=[parent_parser], diff --git a/dvc/command/repro.py b/dvc/command/repro.py index 6fd1b65738..63f532f4e0 100644 --- a/dvc/command/repro.py +++ b/dvc/command/repro.py @@ -57,7 +57,8 @@ def run(self): def add_parser(subparsers, parent_parser): - REPRO_HELP = "Check for changes and reproduce stages and dependencies." + REPRO_HELP = "Reproduce complete or partial pipelines" + " by executing their stages." repro_parser = subparsers.add_parser( "repro", parents=[parent_parser], diff --git a/dvc/command/root.py b/dvc/command/root.py index c17dbf914d..8793620551 100644 --- a/dvc/command/root.py +++ b/dvc/command/root.py @@ -17,7 +17,7 @@ def run(self): def add_parser(subparsers, parent_parser): - ROOT_HELP = "Relative path to the repository's directory." + ROOT_HELP = "Return the relative path to the DVC project." root_parser = subparsers.add_parser( "root", parents=[parent_parser], diff --git a/dvc/command/version.py b/dvc/command/version.py index 60c6109d35..1e35208147 100644 --- a/dvc/command/version.py +++ b/dvc/command/version.py @@ -114,7 +114,8 @@ def get_linktype_support_info(repo): def add_parser(subparsers, parent_parser): - VERSION_HELP = "Show DVC version and system/environment information." + VERSION_HELP = "Display the DVC version" + " and system/environment information." version_parser = subparsers.add_parser( "version", From d5f2ffe88d23a915e95f5366ef7bedc08d30bb7b Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 18 Mar 2020 23:01:08 -0600 Subject: [PATCH 07/11] remote: update help output --- dvc/command/remote.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dvc/command/remote.py b/dvc/command/remote.py index 1e352510cb..14d089a1a2 100644 --- a/dvc/command/remote.py +++ b/dvc/command/remote.py @@ -100,7 +100,7 @@ def run(self): def add_parser(subparsers, parent_parser): from dvc.command.config import parent_config_parser - REMOTE_HELP = "Manage remote storage configuration." + REMOTE_HELP = "Set up and manage data remotes." remote_parser = subparsers.add_parser( "remote", parents=[parent_parser], From f262f483596c78de1befba08061d1e9bec22694f Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 18 Mar 2020 23:01:54 -0600 Subject: [PATCH 08/11] term: file descriptor -> file object --- dvc/external_repo.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dvc/external_repo.py b/dvc/external_repo.py index 362d686f93..6f47a7bd2a 100644 --- a/dvc/external_repo.py +++ b/dvc/external_repo.py @@ -182,7 +182,7 @@ def pull_to(self, path, to_info): @contextmanager def open_by_relpath(self, path, mode="r", encoding=None, **kwargs): - """Opens a specified resource as a file descriptor""" + """Opens a specified resource as a file object.""" try: abs_path = os.path.join(self.root_dir, path) with open(abs_path, mode, encoding=encoding) as fd: From 47090e7dcfb89b1fe98b372a0a87d19baf18b54a Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 18 Mar 2020 23:25:56 -0600 Subject: [PATCH 09/11] metrics: update add and remove help outputs per https://github.com/iterative/dvc/pull/3471#pullrequestreview-377170844 --- dvc/command/metrics.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/dvc/command/metrics.py b/dvc/command/metrics.py index bc4b014f26..04c2f80ee2 100644 --- a/dvc/command/metrics.py +++ b/dvc/command/metrics.py @@ -227,7 +227,7 @@ def add_parser(subparsers, parent_parser): ) metrics_show_parser.set_defaults(func=CmdMetricsShow) - METRICS_ADD_HELP = "Mark output file as a metric." + METRICS_ADD_HELP = "Mark a DVC-tracked file as a metric." metrics_add_parser = metrics_subparsers.add_parser( "add", parents=[parent_parser], @@ -261,7 +261,7 @@ def add_parser(subparsers, parent_parser): metrics_modify_parser.add_argument("path", help="Path to a metric file.") metrics_modify_parser.set_defaults(func=CmdMetricsModify) - METRICS_REMOVE_HELP = "Stop tracking a metric file." + METRICS_REMOVE_HELP = "Remove metric mark on a DVC-tracked file." metrics_remove_parser = metrics_subparsers.add_parser( "remove", parents=[parent_parser], From 377610443f2702356f4ebb4c937a1fe9c901e970 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Thu, 19 Mar 2020 00:02:12 -0600 Subject: [PATCH 10/11] remove: update help output per https://github.com/iterative/dvc/pull/3471#pullrequestreview-377172394 --- dvc/command/remove.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dvc/command/remove.py b/dvc/command/remove.py index d80c029ddb..24c7c1ce02 100644 --- a/dvc/command/remove.py +++ b/dvc/command/remove.py @@ -42,7 +42,7 @@ def run(self): def add_parser(subparsers, parent_parser): - REMOVE_HELP = "Remove data files or directories tracked by DVC." + REMOVE_HELP = "Remove DVC-tracked files or directories." remove_parser = subparsers.add_parser( "remove", parents=[parent_parser], From b6f9cc1819e62932afec5b63a66b5f1125905d80 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Thu, 19 Mar 2020 00:11:27 -0600 Subject: [PATCH 11/11] root: update help output per https://github.com/iterative/dvc/pull/3471#pullrequestreview-377173196 --- dvc/command/root.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dvc/command/root.py b/dvc/command/root.py index 8793620551..f9dadc2ed2 100644 --- a/dvc/command/root.py +++ b/dvc/command/root.py @@ -17,7 +17,7 @@ def run(self): def add_parser(subparsers, parent_parser): - ROOT_HELP = "Return the relative path to the DVC project." + ROOT_HELP = "Return the relative path to the root of the DVC project." root_parser = subparsers.add_parser( "root", parents=[parent_parser],