Skip to content

Commit

Permalink
wording: update command help
Browse files Browse the repository at this point in the history
  • Loading branch information
Mr. Outis and @jorgeorpinel committed Jan 30, 2020
1 parent e9bd959 commit 2c22957
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions dvc/command/diff.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,28 +119,31 @@ def run(self):

def add_parser(subparsers, parent_parser):
DIFF_DESCRIPTION = (
"Show diff of a data file or a directory that is under DVC control.\n"
"Some basic statistics summary, how many files were deleted/changed."
"Compare two different versions of your DVC project (tracked by Git)"
" and shows a list of paths grouped in the following categories:"
" added, modified, or deleted."
)
DIFF_HELP = "Show a diff of a DVC controlled data file or a directory."
diff_parser = subparsers.add_parser(
"diff",
parents=[parent_parser],
description=append_doc_link(DIFF_DESCRIPTION, "diff"),
help=DIFF_HELP,
help=DIFF_DESCRIPTION,
formatter_class=argparse.RawDescriptionHelpFormatter,
)
diff_parser.add_argument(
"a_ref",
help="Git reference from which diff calculates (defaults to HEAD)",
help=(
"Git reference to the old version that you want to compare"
" (defaults to HEAD)"
),
nargs="?",
default="HEAD",
)
diff_parser.add_argument(
"b_ref",
help=(
"Git reference until which diff calculates, if omitted "
"diff shows the difference between the working tree and a_ref"
"Git reference to the new version that you want to compare."
" (defaults to the working tree)"
),
nargs="?",
)
Expand Down

0 comments on commit 2c22957

Please sign in to comment.