diff options
| author | Lakelezz <[email protected]> | 2018-01-31 22:51:30 +0100 |
|---|---|---|
| committer | alex <[email protected]> | 2018-01-31 22:51:30 +0100 |
| commit | 7912f23bed7ddc540c46aee0ecd64c6b60daa0f4 (patch) | |
| tree | eff117ca58ca2c69ffa6f2a4c5f63ba51f19df0a | |
| parent | Multiple audio stream playback, volume control, pausing (diff) | |
| download | serenity-7912f23bed7ddc540c46aee0ecd64c6b60daa0f4.tar.xz serenity-7912f23bed7ddc540c46aee0ecd64c6b60daa0f4.zip | |
Fix customised help related docs (#267)
| -rw-r--r-- | examples/05_command_framework/src/main.rs | 10 | ||||
| -rw-r--r-- | src/framework/standard/create_help_command.rs | 4 |
2 files changed, 7 insertions, 7 deletions
diff --git a/examples/05_command_framework/src/main.rs b/examples/05_command_framework/src/main.rs index 9674db4..b3c9869 100644 --- a/examples/05_command_framework/src/main.rs +++ b/examples/05_command_framework/src/main.rs @@ -141,16 +141,16 @@ fn main() { // a command-name as argument to gain specific information about it. c.individual_command_tip("Hello! こんにちは!Hola! Bonjour! 您好!\n\ If you want more information about a specific command, just pass the command as argument.") - // Some commands require a `{}` to replace it by the actual name. - // In this case it's the command's name. + // Some arguments require a `{}` in order to replace it with contextual information. + // In this case our `{}` refers to a command's name. .command_not_found_text("Could not {}, I'm sorry : (") - // This is the second command requiring `{}` to replace the actual name. + // Another argument requiring `{}`, again replaced with the command's name. .suggestion_text("How about this command: {}, it's numero uno on the market...!") // On another note, you can set up the help-menu-filter-behaviour. - // Here are all possible settings shown on all possible cases. + // Here are all possible settings shown on all possible options. // First case is if a user lacks permissions for a command, we can hide the command. .lacking_permissions(HelpBehaviour::Hide) - // If the user is nothing but lacking a certain role, we just display it hence do `Nothing`. + // If the user is nothing but lacking a certain role, we just display it hence our variant is `Nothing`. .lacking_role(HelpBehaviour::Nothing) // The last `enum`-variant is `Strike`, which ~~strikes~~ a command. .wrong_channel(HelpBehaviour::Strike) diff --git a/src/framework/standard/create_help_command.rs b/src/framework/standard/create_help_command.rs index aba38cc..06f9dda 100644 --- a/src/framework/standard/create_help_command.rs +++ b/src/framework/standard/create_help_command.rs @@ -156,14 +156,14 @@ impl CreateHelpCommand { self } - /// Sets the colour for the embed if an error occured. + /// Sets the colour for the embed if no error occured. pub fn embed_success_colour(mut self, colour: Colour) -> Self { self.0.embed_success_colour = colour; self } - /// Sets the colour for the embed if no error occured. + /// Sets the colour for the embed if an error occured. pub fn embed_error_colour(mut self, colour: Colour) -> Self { self.0.embed_error_colour = colour; |