From bfa1d3e1886b26868a18f2be5e86d5dfb83474df Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Mon, 27 Jan 2020 13:43:43 -0600 Subject: [PATCH] diff/metics diff: update argument descriptions to match https://github.com/iterative/dvc.org/pull/933 --- dvc/command/diff.py | 6 +++--- dvc/command/metrics.py | 10 +++++----- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/dvc/command/diff.py b/dvc/command/diff.py index 7e064adda..26df3c0d1 100644 --- a/dvc/command/diff.py +++ b/dvc/command/diff.py @@ -157,13 +157,13 @@ def add_parser(subparsers, parent_parser): ), ) diff_parser.add_argument( - "a_ref", help="Git reference from which diff calculates" + "a_ref", help="Git reference from which the diff begins" ) diff_parser.add_argument( "b_ref", help=( - "Git reference until which diff calculates, if omitted " - "diff shows the difference between current HEAD and a_ref" + "Git reference until which the diff ends. " + "If omitted, `HEAD` (latest commit) is used." ), nargs="?", ) diff --git a/dvc/command/metrics.py b/dvc/command/metrics.py index 3438202a9..054c4d2c9 100644 --- a/dvc/command/metrics.py +++ b/dvc/command/metrics.py @@ -273,7 +273,7 @@ def add_parser(subparsers, parent_parser): metrics_remove_parser.add_argument("path", help="Path to a metric file.") metrics_remove_parser.set_defaults(func=CmdMetricsRemove) - METRICS_DIFF_HELP = "Output metric values." + METRICS_DIFF_HELP = "Calculates the numeric difference between metrics." metrics_diff_parser = metrics_subparsers.add_parser( "diff", parents=[parent_parser], @@ -285,16 +285,16 @@ def add_parser(subparsers, parent_parser): "a_ref", nargs="?", help=( - "Git reference from which diff is calculated. " - "If omitted `HEAD`(latest commit) is used." + "Git reference from which the diff begins. " + "If omitted, `HEAD` (latest commit) is used." ), ) metrics_diff_parser.add_argument( "b_ref", nargs="?", help=( - "Git reference to which diff is calculated. " - "If omitted current working tree is used." + "Git reference until which the diff ends. " + "If omitted, the current workspace is used instead." ), ) metrics_diff_parser.add_argument(