docs: Clarify when quoting is required for arg

clap-rs · Sep 21, 2022 · a76f622 · a76f622
1 parent b44dbdf
commit a76f622
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/macros.rs b/src/macros.rs
@@ -490,6 +490,9 @@ macro_rules! arg_impl {
 /// A long flag is a `--` followed by either a bare-word or a string, like `--foo` or
 /// `--"foo"`.
 ///
+/// **NOTE:** Dashes in the long name (e.g. `--foo-bar`) is not supported and quoting is required
+/// (e.g. `--"foo-bar"`).
+///
 /// See [`Arg::long`][crate::Arg::long].
 ///
 /// ### Values (Value Notation)