Skip to content

Commit

Permalink
Merge pull request #3908 from jturner314-nrl/derive-ref-quotes
Browse files Browse the repository at this point in the history
docs(derive): Clarify `rename_all` takes a string literal
  • Loading branch information
epage committed Jul 12, 2022
2 parents 7c0068e + f94eafb commit 5c7ad01
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions examples/derive_ref/README.md
Expand Up @@ -152,12 +152,12 @@ when defining subcommands.
- `next_display_order`: `clap::Command::next_display_order`
- `next_help_heading`: `clap::Command::next_help_heading`
- When `flatten`ing `Args`, this is scoped to just the args in this struct and any struct `flatten`ed into it
- `rename_all = <expr>`: Override default field / variant name case conversion for `Command::name` / `Arg::name`
- When not present: `kebab-case`
- Available values: `camelCase`, `kebab-case`, `PascalCase`, `SCREAMING_SNAKE_CASE`, `snake_case`, `lower`, `UPPER`, `verbatim`
- `rename_all_env = <expr>`: Override default field name case conversion for env variables for `clap::Arg::env`
- When not present: `SCREAMING_SNAKE_CASE`
- Available values: `camelCase`, `kebab-case`, `PascalCase`, `SCREAMING_SNAKE_CASE`, `snake_case`, `lower`, `UPPER`, `verbatim`
- `rename_all = <string_literal>`: Override default field / variant name case conversion for `Command::name` / `Arg::name`
- When not present: `"kebab-case"`
- Available values: `"camelCase"`, `"kebab-case"`, `"PascalCase"`, `"SCREAMING_SNAKE_CASE"`, `"snake_case"`, `"lower"`, `"UPPER"`, `"verbatim"`
- `rename_all_env = <string_literal>`: Override default field name case conversion for env variables for `clap::Arg::env`
- When not present: `"SCREAMING_SNAKE_CASE"`
- Available values: `"camelCase"`, `"kebab-case"`, `"PascalCase"`, `"SCREAMING_SNAKE_CASE"`, `"snake_case"`, `"lower"`, `"UPPER"`, `"verbatim"`

And for `Subcommand` variants:
- `skip`: Ignore this variant
Expand Down Expand Up @@ -228,9 +228,9 @@ These correspond to a `clap::Arg`.

### Arg Enum Attributes

- `rename_all = <expr>`: Override default field / variant name case conversion for `PossibleValue::new`
- When not present: `kebab-case`
- Available values: `camelCase`, `kebab-case`, `PascalCase`, `SCREAMING_SNAKE_CASE`, `snake_case`, `lower`, `UPPER`, `verbatim`
- `rename_all = <string_literal>`: Override default field / variant name case conversion for `PossibleValue::new`
- When not present: `"kebab-case"`
- Available values: `"camelCase"`, `"kebab-case"`, `"PascalCase"`, `"SCREAMING_SNAKE_CASE"`, `"snake_case"`, `"lower"`, `"UPPER"`, `"verbatim"`

### Possible Value Attributes

Expand Down

0 comments on commit 5c7ad01

Please sign in to comment.