Skip to content

Commit 27511d1

Browse files
committed
[update] documentation around argument lookups
1 parent d38f2b7 commit 27511d1

File tree

1 file changed

+4
-1
lines changed
  • crates/lambda-rs-args/src

1 file changed

+4
-1
lines changed

crates/lambda-rs-args/src/lib.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1071,7 +1071,10 @@ impl ParsedArgs {
10711071
/// Returns a count value by name, if present and typed as integer.
10721072
///
10731073
/// # Arguments
1074-
/// - `name`: The declared argument name (for example, `"-v"`).
1074+
/// - `name`: The declared argument name (for example, `"--verbose"`).
1075+
/// If you declared a long flag with an alias (for example, `"--verbose"`
1076+
/// with alias `"-v"`), lookups must use `"--verbose"`. Passing `"-v"` is
1077+
/// only correct when `"-v"` is the declared name.
10751078
///
10761079
/// # Returns
10771080
/// Returns `Some(i64)` when the argument exists and is an integer, otherwise

0 commit comments

Comments
 (0)