Skip to content

Commit 4f92041

Browse files
committed
Expand docs
1 parent 2201118 commit 4f92041

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

pkgs/args/lib/src/arg_parser.dart

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,12 @@ class ArgParser {
177177
///
178178
/// The [allowedHelp] argument is a map from values in [allowed] to
179179
/// documentation for those values that will be included in [usage].
180+
/// The map may include a subset of the allowed values.
181+
/// Additional values that are not in [allowed] should be omitted, however
182+
/// there is no validation.
183+
/// When both [allowed] and [allowedHelp] are passed, only [allowed] will
184+
/// be validated at parse time, and only [allowedHelp] will be included in
185+
/// usage output.
180186
///
181187
/// The [defaultsTo] argument indicates the value this option will have if the
182188
/// user doesn't explicitly pass it in (or `null` by default).
@@ -231,6 +237,12 @@ class ArgParser {
231237
///
232238
/// The [allowedHelp] argument is a map from values in [allowed] to
233239
/// documentation for those values that will be included in [usage].
240+
/// The map may include a subset of the allowed values.
241+
/// Additional values that are not in [allowed] should be omitted, however
242+
/// there is no validation.
243+
/// When both [allowed] and [allowedHelp] are passed, only [allowed] will
244+
/// be validated at parse time, and only [allowedHelp] will be included in
245+
/// usage output.
234246
///
235247
/// The [defaultsTo] argument indicates the values this option will have if
236248
/// the user doesn't explicitly pass it in (or `[]` by default).

0 commit comments

Comments
 (0)