OpenSource/teloxide
OpenSource/teloxide
1
0
Fork 0
mirror of https://github.com/teloxide/teloxide.git synced 2024-12-22 14:35:36 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add documentation for #[command(hide)]

Browse source
This commit is contained in:
TheAwiteb 2023-03-02 20:49:49 +03:00 committed by Maybe Waffle
parent ebdab88311
commit dd24f750f2
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
crates/teloxide/src/utils/command.rs
View file

@ -168,14 +168,16 @@ pub use teloxide_macros::BotCommands;
/// `rename_rule`).
///
/// 3. `#[command(description = "description")]`
/// Give your command a description. Write `"off"` for `"description"` to hide a
/// command.
/// Give your command a description. It will be shown in the help message.
///
/// 4. `#[command(parse_with = "parser")]`
/// Parse arguments of one command with a given parser. `parser` must be a
/// function of the signature `fn(String) -> Result<Tuple, ParseError>`, where
/// `Tuple` corresponds to the variant's arguments.
///
/// 5. `#[command(hide)]`
/// Hide a command from the help message. It will still be parsed.
///
/// ## Example
/// ```
/// # #[cfg(feature = "macros")] {