docs: add doc comment for asExistingFile

shorebirdtech · Jul 12, 2024 · eac1158 · eac1158
1 parent cf99f6e
commit eac1158
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/updater_tools/lib/src/extensions/arg_results.dart b/updater_tools/lib/src/extensions/arg_results.dart
@@ -4,6 +4,8 @@ import 'package:args/args.dart';
 
 /// Extension methods for validating options provided to [ArgResults].
 extension ArgResultsValidation on ArgResults {
+  /// Returns the value of the option named [name] as a [File]. If the file
+  /// does not exist, an [ArgumentError] is thrown.
   File asExistingFile(String name) {
     final file = File(this[name] as String);
     if (!file.existsSync()) {