diff --git a/dvc/command/data_sync.py b/dvc/command/data_sync.py index 7be18cc747..a7decd18b5 100644 --- a/dvc/command/data_sync.py +++ b/dvc/command/data_sync.py @@ -102,7 +102,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", @@ -152,8 +152,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", @@ -196,7 +195,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/metrics.py b/dvc/command/metrics.py index 038e2f2669..04c2f80ee2 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 a DVC-tracked 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 options." + 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 = "Remove metric mark on a DVC-tracked file." metrics_remove_parser = metrics_subparsers.add_parser( "remove", parents=[parent_parser], diff --git a/dvc/command/pipeline.py b/dvc/command/pipeline.py index 6aedb086ad..a265f10e11 100644 --- a/dvc/command/pipeline.py +++ b/dvc/command/pipeline.py @@ -175,7 +175,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], @@ -231,7 +231,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..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], @@ -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..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 DVC-file outputs." + REMOVE_HELP = "Remove DVC-tracked files or directories." 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..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 = "Relative path to the repository's directory." + ROOT_HELP = "Return the relative path to the root of 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 3a4fe042d6..e22620bb78 100644 --- a/dvc/command/version.py +++ b/dvc/command/version.py @@ -126,7 +126,8 @@ def get_supported_remotes(): 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", diff --git a/dvc/external_repo.py b/dvc/external_repo.py index 068335ae32..6a8000e7ac 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 object.""" try: abs_path = os.path.join(self.root_dir, path) with open(abs_path, mode, encoding=encoding) as fd: