get/import: update output (again?)

[jorgeorpinel]

I'm not sure what happened because I think we've changed this recently (e.g. #3077), but I'm seeing:

$ dvc version
DVC version: 0.80.0
Python version: 3.7.6
Platform: Darwin-19.0.0-x86_64-i386-64bit
Binary: False
Package: brew

$ dvc get -h
usage: dvc get [-h] [-q | -v] [-o [OUT]] [--rev [REV]] url path

Download/copy files or directories from DVC repository...

positional arguments:
  url                   URL of Git repository with DVC project to download
                        from.
  path                  Path to a file or directory within a DVC repository.
...

$ dvc import -h
usage: dvc import [-h] [-q | -v] [-o [OUT]] [--rev [REV]] url path

Download data from DVC repository and take it under DVC control...

positional arguments:
  url                   URL of Git repository with DVC project to download from.
  path                  Path to data within DVC repository.
...

The descriptions of the commands as well as of their arguments are outdated. Maybe there was a bad merge somewhere but from what I'm seeing in the docs, they should be something like:

get
Download file or directory from any DVC project or Git repository.

import
Download file or directory from any DVC project or Git repository into the workspace, and track it.

positional arguments

  url         Location of DVC project or Git repository to download from
  path        Path to a file or directory within the project or repository

which I remember came from PRs to this repo. So anyway, we should update it again, I think. I can do it myself if people agree.

• And make sure docs are in sync with the same text as well. Implicit in get/imp: update help output descriptions #3214

[pared]

Checked the master and the latest version (0.82.1) and it seems to me that help output is proper.

• get help
• import help

It seems that 0.80.0 was released at the beginning of January, so it might be that those changes were not incorporated back then.

@jorgeorpinel ?

[jorgeorpinel]

Hm yeah this newest version seems closer to correct:

dvc/dvc/command/get.py

Lines 53 to 56 in 04161ad

	def add_parser(subparsers, parent_parser):
	GET_HELP = (
	"Download a file or directory from any DVC project or Git repository."
	)

unnecessary "a" but its OK

dvc/dvc/command/get.py

Lines 64 to 71 in 04161ad

	get_parser.add_argument(
	"url",
	help="Location of DVC project or Git repository to download from",
	)
	get_parser.add_argument(
	"path",
	help="Path to a file or directory within the project or repository",
	)

perfect
and

dvc/dvc/command/imp.py

Lines 31 to 35 in 04161ad

	def add_parser(subparsers, parent_parser):
	IMPORT_HELP = (
	"Download a file or directory from any DVC project or Git repository "
	"and take it under DVC control."
	)

we no longer like the "take under control" phrase (see iterative/dvc.org/issues/719) so let's use "Download file or directory from any DVC project or Git repository into the workspace, and track it." as suggested above.

dvc/dvc/command/imp.py

Lines 44 to 51 in 04161ad

	import_parser.add_argument(
	"url",
	help="Location of DVC project or Git repository to download from",
	)
	import_parser.add_argument(
	"path",
	help="Path to a file or directory within the project or repository",
	)

perfect
Let me think...
EDIT: I've updated the comment with notes on what to change, will open a small PR for this.

[jorgeorpinel]

will open a small PR for this.

Done: #3214