docs: add comment about Option's mandatory attribute

dart-archive · Sep 8, 2024 · 7665d30 · 7665d30
1 parent e623652
commit 7665d30
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lib/src/arg_parser.dart b/lib/src/arg_parser.dart
@@ -180,6 +180,10 @@ class ArgParser {
   /// often surprising, and its use is discouraged in favor of reading values
   /// from the [ArgResults].
   ///
+  /// If [mandatory] is `true` an exception will be thrown when this option is
+  /// accessed but not set. If this option is not set and not accessed, no 
+  /// exception is thrown.
+  ///
   /// If [hide] is `true`, this option won't be included in [usage].
   ///
   /// If [aliases] is provided, these are used as aliases for [name]. These