mirror of
https://github.com/teloxide/teloxide.git
synced 2024-12-22 22:46:39 +01:00
Merge pull request #727 from teloxide/update-bot-commands-docs
Update the docs of `BotCommands`
This commit is contained in:
commit
f7684fef29
1 changed files with 17 additions and 16 deletions
|
@ -82,11 +82,10 @@ pub use teloxide_macros::BotCommands;
|
||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
/// # Enum attributes
|
/// # Enum attributes
|
||||||
/// 1. `#[command(rename = "rule")]`
|
/// 1. `#[command(rename_rule = "rule")]`
|
||||||
/// Rename all commands by `rule`. If you will not use this attribute, commands
|
/// Rename all commands by `rule`. Allowed rules are `lowercase`, `UPPERCASE`,
|
||||||
/// will be parsed by their original names. Allowed rules are `lowercase`,
|
/// `PascalCase`, `camelCase`, `snake_case`, `SCREAMING_SNAKE_CASE`,
|
||||||
/// `UPPERCASE`, `PascalCase`, `camelCase`, `snake_case`,
|
/// `kebab-case`, and `SCREAMING-KEBAB-CASE`.
|
||||||
/// `SCREAMING_SNAKE_CASE`, `kebab-case`, and `SCREAMING-KEBAB-CASE`.
|
|
||||||
///
|
///
|
||||||
/// 2. `#[command(prefix = "prefix")]`
|
/// 2. `#[command(prefix = "prefix")]`
|
||||||
/// Change a prefix for all commands (the default is `/`).
|
/// Change a prefix for all commands (the default is `/`).
|
||||||
|
@ -159,21 +158,23 @@ pub use teloxide_macros::BotCommands;
|
||||||
/// # Variant attributes
|
/// # Variant attributes
|
||||||
/// All variant attributes override the corresponding `enum` attributes.
|
/// All variant attributes override the corresponding `enum` attributes.
|
||||||
///
|
///
|
||||||
/// 1. `#[command(rename = "rule")]`
|
/// 1. `#[command(rename_rule = "rule")]`
|
||||||
/// Rename one command by a rule. Allowed rules are `lowercase`, `UPPERCASE`,
|
/// Rename one command by a rule. Allowed rules are `lowercase`, `UPPERCASE`,
|
||||||
/// `PascalCase`, `camelCase`, `snake_case`, `SCREAMING_SNAKE_CASE`,
|
/// `PascalCase`, `camelCase`, `snake_case`, `SCREAMING_SNAKE_CASE`,
|
||||||
/// `kebab-case`, `SCREAMING-KEBAB-CASE`, and `%some_name%`, where `%some_name%`
|
/// `kebab-case`, `SCREAMING-KEBAB-CASE`.
|
||||||
/// is any string, a new name.
|
|
||||||
///
|
///
|
||||||
/// 2. `#[command(description = "description")]`
|
/// 2. `#[command(rename = "name")]`
|
||||||
|
/// Rename one command to `name` (literal renaming; do not confuse with
|
||||||
|
/// `rename_rule`).
|
||||||
|
///
|
||||||
|
/// 3. `#[command(description = "description")]`
|
||||||
/// Give your command a description. Write `"off"` for `"description"` to hide a
|
/// Give your command a description. Write `"off"` for `"description"` to hide a
|
||||||
/// command.
|
/// command.
|
||||||
///
|
///
|
||||||
/// 3. `#[command(parse_with = "parser")]`
|
/// 4. `#[command(parse_with = "parser")]`
|
||||||
/// One more option is available for variants.
|
/// Parse arguments of one command with a given parser. `parser` must be a
|
||||||
/// - `custom_parser` - your own parser of the signature `fn(String) ->
|
/// function of the signature `fn(String) -> Result<Tuple, ParseError>`, where
|
||||||
/// Result<Tuple, ParseError>`, where `Tuple` corresponds to the variant's
|
/// `Tuple` corresponds to the variant's arguments.
|
||||||
/// arguments.
|
|
||||||
///
|
///
|
||||||
/// ## Example
|
/// ## Example
|
||||||
/// ```
|
/// ```
|
||||||
|
@ -204,8 +205,8 @@ pub use teloxide_macros::BotCommands;
|
||||||
/// # }
|
/// # }
|
||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
/// 4. `#[command(prefix = "prefix")]`
|
/// 5. `#[command(prefix = "prefix")]`
|
||||||
/// 5. `#[command(separator = "sep")]`
|
/// 6. `#[command(separator = "sep")]`
|
||||||
///
|
///
|
||||||
/// These attributes just override the corresponding `enum` attributes for a
|
/// These attributes just override the corresponding `enum` attributes for a
|
||||||
/// specific variant.
|
/// specific variant.
|
||||||
|
|
Loading…
Reference in a new issue