Skip to content

Commit 11382cc

Browse files
authored
cmd: help output updates (per docs) (#4999)
* 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)
1 parent eb8e03a commit 11382cc

File tree

3 files changed

+9
-4
lines changed

3 files changed

+9
-4
lines changed

dvc/command/commit.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,10 @@ def run(self):
3232

3333

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

3740
commit_parser = subparsers.add_parser(
3841
"commit",

dvc/command/data_sync.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,9 @@ def add_parser(subparsers, _parent_parser):
243243
push_parser.set_defaults(func=CmdDataPush)
244244

245245
# Fetch
246-
FETCH_HELP = "Download cached files or directories from remote storage."
246+
FETCH_HELP = (
247+
"Download files or directories from remote storage to the cache."
248+
)
247249

248250
fetch_parser = subparsers.add_parser(
249251
"fetch",

dvc/command/remove.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ def run(self):
2121

2222
def add_parser(subparsers, parent_parser):
2323
REMOVE_HELP = (
24-
"Remove stages or .dvc files, unprotect their outputs, and"
25-
" erase .gitignore entries."
24+
"Remove stages from dvc.yaml and/or"
25+
" stop tracking files or directories."
2626
)
2727
remove_parser = subparsers.add_parser(
2828
"remove",

0 commit comments

Comments
 (0)