doc: Explain return value

juanibiapina · Jun 20, 2024 · cdab419 · cdab419
1 parent b5c23d3
commit cdab419
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/usage.rs b/src/usage.rs
@@ -186,6 +186,8 @@ pub fn extract_usage(config: &Config, path: &Path, cmd: &str) -> Usage {
         command = command.arg(Arg::new("args").trailing_var_arg(true).num_args(..).allow_hyphen_values(true));
     }
 
+    // both command and error are returned because an invalid usage string doesn't prevent the
+    // command from being invoked, but it should be reported to the user
     return Usage::new(command, error);
 }