Skip to content

Commit 9cb32b5

Browse files
jorgeorpinelefiop
andauthored
check-ignore: update help output (#4358)
* check_ignore: update help output per #4282 (review) and #4282 (review) * check-ignore: more output string updates per #4323 et al. * check-ignore: min text update to match iterative/dvc.org/pull/1673 Co-authored-by: Ruslan Kuprieiev <[email protected]>
1 parent 765d2ed commit 9cb32b5

File tree

1 file changed

+15
-17
lines changed

1 file changed

+15
-17
lines changed

dvc/command/check_ignore.py

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,9 @@ def run(self):
8181

8282

8383
def add_parser(subparsers, parent_parser):
84-
ADD_HELP = "Debug DVC ignore/exclude files"
84+
ADD_HELP = (
85+
"Check whether files or directories are excluded due to `.dvcignore`."
86+
)
8587

8688
parser = subparsers.add_parser(
8789
"check-ignore",
@@ -95,35 +97,31 @@ def add_parser(subparsers, parent_parser):
9597
"--details",
9698
action="store_true",
9799
default=False,
98-
help="Show the exclude pattern together with each target path.",
100+
help="Show the exclude patterns along with each target path.",
99101
)
100102
parser.add_argument(
101-
"-n",
102-
"--non-matching",
103+
"-a",
104+
"--all",
103105
action="store_true",
104106
default=False,
105-
help="Show the target paths which don’t match any pattern. "
106-
"Only usable when `--details` is also employed",
107+
help="Include the target paths which don’t match any pattern "
108+
"in the `--details` list.",
107109
)
108110
parser.add_argument(
109-
"--stdin",
111+
"-n",
112+
"--non-matching",
110113
action="store_true",
111114
default=False,
112-
help="Read pathnames from the standard input, one per line, "
113-
"instead of from the command-line.",
115+
help="Include the target paths which don’t match any pattern "
116+
"in the `--details` list.",
114117
)
115118
parser.add_argument(
116-
"-a",
117-
"--all",
119+
"--stdin",
118120
action="store_true",
119121
default=False,
120-
help="Show all of the patterns match the target paths. "
121-
"Only usable when `--details` is also employed",
122+
help="Read paths from standard input instead of providing `targets`.",
122123
)
123124
parser.add_argument(
124-
"targets",
125-
nargs="*",
126-
help="Exact or wildcard paths of files or directories to check "
127-
"ignore patterns.",
125+
"targets", nargs="*", help="File or directory paths to check",
128126
).complete = completion.FILE
129127
parser.set_defaults(func=CmdCheckIgnore)

0 commit comments

Comments
 (0)