Skip to content

Commit

Permalink
docs(clap_app!): documents the --("some-arg") method for using args…
Browse files Browse the repository at this point in the history
… with hyphens inside them

Closes #919
  • Loading branch information
kbknapp committed Apr 5, 2017
1 parent 59272b0 commit bc08ef3
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/macros.rs
Original file line number Diff line number Diff line change
Expand Up @@ -562,6 +562,8 @@ macro_rules! app_from_crate {
///
/// * A single hyphen followed by a character (such as `-c`) sets the [`Arg::short`]
/// * A double hyphen followed by a character or word (such as `--config`) sets [`Arg::long`]
/// * If one wishes to use a [`Arg::long`] with a hyphen inside (i.e. `--config-file`), you
/// must use `--("config-file")` due to limitations of the Rust macro system.
/// * Three dots (`...`) sets [`Arg::multiple(true)`]
/// * Angled brackets after either a short or long will set [`Arg::value_name`] and
/// `Arg::required(true)` such as `--config <FILE>` = `Arg::value_name("FILE")` and
Expand Down

0 comments on commit bc08ef3

Please sign in to comment.