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

Merge pull request #5229 from epage/derive

Browse source 
docs(derive): Link to tutorial sections for attributes
This commit is contained in:
Ed Page 2023-11-27 16:31:35 -06:00 committed by GitHub
commit b661a9de04
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
src/_derive/mod.rs
View file

@ -189,6 +189,9 @@
//! [`Subcommand`][crate::Subcommand]) //! [`Subcommand`][crate::Subcommand])
//! - When `Option<T>`, the subcommand becomes optional //! - When `Option<T>`, the subcommand becomes optional
//! //!
//! See [Configuring the Parser][_tutorial::chapter_1] and
//! [Subcommands][_tutorial::chapter_2#subcommands] from the tutorial.
//!
//! ### ArgGroup Attributes //! ### ArgGroup Attributes
//! //!
//! These correspond to the [`ArgGroup`][crate::ArgGroup] which is implicitly created for each //! These correspond to the [`ArgGroup`][crate::ArgGroup] which is implicitly created for each
@ -207,6 +210,8 @@
//! - For `struct`s, [`multiple = true`][crate::ArgGroup::multiple] is implied //! - For `struct`s, [`multiple = true`][crate::ArgGroup::multiple] is implied
//! - `enum` support is tracked at [#2621](https://github.com/clap-rs/clap/issues/2621) //! - `enum` support is tracked at [#2621](https://github.com/clap-rs/clap/issues/2621)
//! //!
//! See [Argument Relations][_tutorial::chapter_3#argument-relations] from the tutorial.
//!
//! ### Arg Attributes //! ### Arg Attributes
//! //!
//! These correspond to a [`Arg`][crate::Arg]. //! These correspond to a [`Arg`][crate::Arg].
@ -256,12 +261,17 @@
//! - Requires field arg to be of type `Vec<T>` and `T` to implement `std::convert::Into<OsString>` or `#[arg(value_enum)]` //! - Requires field arg to be of type `Vec<T>` and `T` to implement `std::convert::Into<OsString>` or `#[arg(value_enum)]`
//! - `<expr>` must implement `IntoIterator<T>` //! - `<expr>` must implement `IntoIterator<T>`
//! //!
//! See [Adding Arguments][_tutorial::chapter_2] and [Validation][_tutorial::chapter_3] from the
//! tutorial.
//!
//! ### ValueEnum Attributes //! ### ValueEnum Attributes
//! //!
//! - `rename_all = <string_literal>`: Override default field / variant name case conversion for [`PossibleValue::new`][crate::builder::PossibleValue] //! - `rename_all = <string_literal>`: Override default field / variant name case conversion for [`PossibleValue::new`][crate::builder::PossibleValue]
//! - When not present: `"kebab-case"` //! - When not present: `"kebab-case"`
//! - Available values: `"camelCase"`, `"kebab-case"`, `"PascalCase"`, `"SCREAMING_SNAKE_CASE"`, `"snake_case"`, `"lower"`, `"UPPER"`, `"verbatim"` //! - Available values: `"camelCase"`, `"kebab-case"`, `"PascalCase"`, `"SCREAMING_SNAKE_CASE"`, `"snake_case"`, `"lower"`, `"UPPER"`, `"verbatim"`
//! //!
//! See [Enumerated values][_tutorial::chapter_3#enumerated-values] from the tutorial.
//!
//! ### Possible Value Attributes //! ### Possible Value Attributes
//! //!
//! These correspond to a [`PossibleValue`][crate::builder::PossibleValue]. //! These correspond to a [`PossibleValue`][crate::builder::PossibleValue].