diff options
| author |  Shivansh <[email protected]> | 2021-04-30 07:19:52 +0530 |
|---|---|---|
| committer | Shivansh <[email protected]> | 2021-04-30 07:19:52 +0530 |
| commit | 8e6e27c2400e0d630d3e8da93189e7d3fc0d39e7 (patch) | |
| tree | f35aa5d29fe0fb80b1f6ea097f5f4e14cd86e2d5 | |
| parent | Apply requested grammar changes. (diff) | |
Give more information in function doc-strings
| -rw-r--r-- | bot/exts/pride/pride_leader.py | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/bot/exts/pride/pride_leader.py b/bot/exts/pride/pride_leader.py index d955a2cc..5ecfd2ea 100644 --- a/bot/exts/pride/pride_leader.py +++ b/bot/exts/pride/pride_leader.py @@ -33,7 +33,17 @@ class PrideLeader(commands.Cog): log.trace(f"Got a Invalid pride leader: {leader_name}") def invalid_embed_generate(self, pride_leader: str) -> discord.Embed: - """Generates Invalid Embed.""" + """ + Generates Invalid Embed. + + The invalid embed contains a list of closely matched names of the invalid pride + leader the user gave. If no closely matched names are found it would list all + the available pride leader names. + + Wikipedia is a useful place to learn about pride leaders and we don't have all + the pride leaders, so the bot would add a field containing the wikipedia + command to execute. + """ embed = discord.Embed( color=constants.Colours.soft_red ) |