Skip to content

Commit

Permalink
cmd: help output updates (per docs) (#4999)
Browse files Browse the repository at this point in the history
* cmd: matching help output to docs
per iterative/dvc.org#1971 (review)
and iterative/dvc.org#1978 (review)

* fetch: simplify help text
per iterative/dvc.org#1978 (review)

* commit: update help output to match iterative/dvc.org/pull/1978

* fetch: update help output to match iterative/dvc.org/pull/1978

* commmit: help output update (again)

* remove: simplify help output
per iterative/dvc.org#1971 (review)

* remove: simplify help output
per iterative/dvc.org#1971 (review)

* commit: update -h output
per iterative/dvc.org#1989 (review)
  • Loading branch information
jorgeorpinel authored Dec 25, 2020
1 parent eb8e03a commit 11382cc
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
5 changes: 4 additions & 1 deletion dvc/command/commit.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@ def run(self):


def add_parser(subparsers, parent_parser):
COMMIT_HELP = "Save changed data to cache and update DVC-files."
COMMIT_HELP = (
"Record changes to files or directories tracked by DVC"
" by storing the current versions in the cache."
)

commit_parser = subparsers.add_parser(
"commit",
Expand Down
4 changes: 3 additions & 1 deletion dvc/command/data_sync.py
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,9 @@ def add_parser(subparsers, _parent_parser):
push_parser.set_defaults(func=CmdDataPush)

# Fetch
FETCH_HELP = "Download cached files or directories from remote storage."
FETCH_HELP = (
"Download files or directories from remote storage to the cache."
)

fetch_parser = subparsers.add_parser(
"fetch",
Expand Down
4 changes: 2 additions & 2 deletions dvc/command/remove.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ def run(self):

def add_parser(subparsers, parent_parser):
REMOVE_HELP = (
"Remove stages or .dvc files, unprotect their outputs, and"
" erase .gitignore entries."
"Remove stages from dvc.yaml and/or"
" stop tracking files or directories."
)
remove_parser = subparsers.add_parser(
"remove",
Expand Down

0 comments on commit 11382cc

Please sign in to comment.