@@ -81,7 +81,9 @@ def run(self):
81
81
82
82
83
83
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
+ )
85
87
86
88
parser = subparsers .add_parser (
87
89
"check-ignore" ,
@@ -95,35 +97,31 @@ def add_parser(subparsers, parent_parser):
95
97
"--details" ,
96
98
action = "store_true" ,
97
99
default = False ,
98
- help = "Show the exclude pattern together with each target path." ,
100
+ help = "Show the exclude patterns along with each target path." ,
99
101
)
100
102
parser .add_argument (
101
- "-n " ,
102
- "--non-matching " ,
103
+ "-a " ,
104
+ "--all " ,
103
105
action = "store_true" ,
104
106
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. " ,
107
109
)
108
110
parser .add_argument (
109
- "--stdin" ,
111
+ "-n" ,
112
+ "--non-matching" ,
110
113
action = "store_true" ,
111
114
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 ." ,
114
117
)
115
118
parser .add_argument (
116
- "-a" ,
117
- "--all" ,
119
+ "--stdin" ,
118
120
action = "store_true" ,
119
121
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`." ,
122
123
)
123
124
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" ,
128
126
).complete = completion .FILE
129
127
parser .set_defaults (func = CmdCheckIgnore )
0 commit comments