From ce9205a3ccf199720a8286452023bc88e563b41b Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 12 Aug 2020 17:12:45 -0500 Subject: [PATCH] term: review "URL" term usage in remote cmds, and get/import-url (#4364) * term: review upper case URL usage, and remote add url arg desc * get/imp-url: better url arg help out * Update dvc/command/get_url.py Co-authored-by: Ruslan Kuprieiev --- dvc/command/imp_url.py | 20 ++++++++------------ dvc/command/remote.py | 6 +++--- 2 files changed, 11 insertions(+), 15 deletions(-) diff --git a/dvc/command/imp_url.py b/dvc/command/imp_url.py index 4451b8e298..eb19896f76 100644 --- a/dvc/command/imp_url.py +++ b/dvc/command/imp_url.py @@ -42,20 +42,16 @@ def add_parser(subparsers, parent_parser): ) import_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" + help="Location of the data to download. Supported URLs:\n" + "/absolute/path/to/file/or/dir\n" + "relative/path/to/file/or/dir\n" + "C:\\\\path\\to\\file\\or\\dir\n" "https://example.com/path/to/file\n" - "s3://bucket/path/to/file\n" - "s3://bucket/path/to/directory\n" - "gs://bucket/path/to/file\n" - "gs://bucket/path/to/directory\n" + "s3://bucket/key/path\n" + "gs://bucket/path/to/file/or/dir\n" "hdfs://example.com/path/to/file\n" - "ssh://example.com:/path/to/file\n" - "ssh://example.com:/path/to/directory\n" - "remote://myremote/path/to/file (see `dvc remote`)", + "ssh://example.com/absolute/path/to/file/or/dir\n" + "remote://remote_name/path/to/file/or/dir (see `dvc remote`)", ) import_parser.add_argument( "out", nargs="?", help="Destination path to put files to.", diff --git a/dvc/command/remote.py b/dvc/command/remote.py index 1cb4a3a869..de3f566531 100644 --- a/dvc/command/remote.py +++ b/dvc/command/remote.py @@ -172,7 +172,7 @@ def add_parser(subparsers, parent_parser): remote_add_parser.add_argument("name", help="Name of the remote") remote_add_parser.add_argument( "url", - help="URL. See full list of supported urls at {}".format( + help="Remote location. See full list of supported URLs at {}".format( format_link("https://man.dvc.org/remote") ), ) @@ -201,7 +201,7 @@ def add_parser(subparsers, parent_parser): formatter_class=argparse.RawDescriptionHelpFormatter, ) remote_default_parser.add_argument( - "name", nargs="?", help="Name of the remote." + "name", nargs="?", help="Name of the remote" ) remote_default_parser.add_argument( "-u", @@ -220,7 +220,7 @@ def add_parser(subparsers, parent_parser): help=REMOTE_MODIFY_HELP, formatter_class=argparse.RawDescriptionHelpFormatter, ) - remote_modify_parser.add_argument("name", help="Name of the remote.") + remote_modify_parser.add_argument("name", help="Name of the remote") remote_modify_parser.add_argument( "option", help="Name of the option to modify." )