Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-12-13 14:22:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs(derive): Make raw attribute more discoverable

Browse source 
Based on feedback in #3189
This commit is contained in:
Ed Page 2022-05-30 18:41:01 -05:00
parent 54a153021b
commit b39d3d4f2b
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
examples/derive_ref/README.md
View file

@ -128,6 +128,9 @@ attributes.
These correspond to a `clap::Command` which is used for both top-level parsers and These correspond to a `clap::Command` which is used for both top-level parsers and
when defining subcommands. when defining subcommands.
**Raw attributes:** Any [`Command` method](https://docs.rs/clap/latest/clap/type.Command.html) can also be used as an attribute, see [Terminology](#terminology) for syntax.
- e.g. `#[clap(arg_required_else_help(true))]` would translate to `cmd.arg_required_else_help(true)`
**Magic attributes:** **Magic attributes:**
- `name = <expr>`: `clap::Command::name` - `name = <expr>`: `clap::Command::name`
- When not present: [crate `name`](https://doc.rust-lang.org/cargo/reference/manifest.html#the-name-field) (`Parser` container), variant name (`Subcommand` variant) - When not present: [crate `name`](https://doc.rust-lang.org/cargo/reference/manifest.html#the-name-field) (`Parser` container), variant name (`Subcommand` variant)
@ -163,13 +166,13 @@ And for `Subcommand` variants:
- `external_subcommand`: `clap::Command::allow_external_subcommand(true)` - `external_subcommand`: `clap::Command::allow_external_subcommand(true)`
- Variant must be either `Variant(Vec<String>)` or `Variant(Vec<OsString>)` - Variant must be either `Variant(Vec<String>)` or `Variant(Vec<OsString>)`
**Raw attributes:** Any [`Command` method](https://docs.rs/clap/latest/clap/type.Command.html) can also be used as an attribute, see [Terminology](#terminology) for syntax.
- e.g. `#[clap(arg_required_else_help(true))]` would translate to `cmd.arg_required_else_help(true)`
### Arg Attributes ### Arg Attributes
These correspond to a `clap::Arg`. These correspond to a `clap::Arg`.
**Raw attributes:** Any [`Arg` method](https://docs.rs/clap/latest/clap/struct.Arg.html) can also be used as an attribute, see [Terminology](#terminology) for syntax.
- e.g. `#[clap(max_values(3))]` would translate to `arg.max_values(3)`
**Magic attributes**: **Magic attributes**:
- `name = <expr>`: `clap::Arg::new` - `name = <expr>`: `clap::Arg::new`
- When not present: case-converted field name is used - When not present: case-converted field name is used
@ -216,9 +219,6 @@ These correspond to a `clap::Arg`.
- Requires `std::convert::Into<OsString>` or `#[clap(arg_enum)]` - Requires `std::convert::Into<OsString>` or `#[clap(arg_enum)]`
- Without `<expr>`, relies on `Default::default()` - Without `<expr>`, relies on `Default::default()`
**Raw attributes:** Any [`Arg` method](https://docs.rs/clap/latest/clap/struct.Arg.html) can also be used as an attribute, see [Terminology](#terminology) for syntax.
- e.g. `#[clap(max_values(3))]` would translate to `arg.max_values(3)`
### Arg Enum Attributes ### Arg Enum Attributes
- `rename_all = <expr>`: Override default field / variant name case conversion for `PossibleValue::new` - `rename_all = <expr>`: Override default field / variant name case conversion for `PossibleValue::new`
@ -229,15 +229,15 @@ These correspond to a `clap::Arg`.
These correspond to a `clap::PossibleValue`. These correspond to a `clap::PossibleValue`.
**Raw attributes:** Any [`PossibleValue` method](https://docs.rs/clap/latest/clap/struct.PossibleValue.html) can also be used as an attribute, see [Terminology](#terminology) for syntax.
- e.g. `#[clap(alias("foo"))]` would translate to `pv.alias("foo")`
**Magic attributes**: **Magic attributes**:
- `name = <expr>`: `clap::PossibleValue::new` - `name = <expr>`: `clap::PossibleValue::new`
- When not present: case-converted field name is used - When not present: case-converted field name is used
- `help = <expr>`: `clap::PossibleValue::help` - `help = <expr>`: `clap::PossibleValue::help`
- When not present: [Doc comment summary](#doc-comments) - When not present: [Doc comment summary](#doc-comments)
**Raw attributes:** Any [`PossibleValue` method](https://docs.rs/clap/latest/clap/struct.PossibleValue.html) can also be used as an attribute, see [Terminology](#terminology) for syntax.
- e.g. `#[clap(alias("foo"))]` would translate to `pv.alias("foo")`
## Arg Types ## Arg Types
`clap` assumes some intent based on the type used: `clap` assumes some intent based on the type used: