matthew/enhanced-discord.py
1
0
Fork 0
Code Issues 4 Pull Requests 21 Projects Releases Wiki Activity

[commands] Add Cog.description to get the clean docstring.

Browse Source
This commit is contained in:
Rapptz 2019-03-14 03:53:19 -04:00
parent c4a21cc1d4
commit 27c6d2c923
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
discord/ext/commands/cog.py
View File

@ -181,6 +181,15 @@ class Cog(metaclass=CogMeta):
""":class:`str`: Returns the cog's specified name, not the class name.""" """:class:`str`: Returns the cog's specified name, not the class name."""
return self.__cog_name__ return self.__cog_name__
@property
def description(self):
""":class:`str`: Returns the cog's description, typically the cleaned docstring."""
try:
return self.__cog_cleaned_doc__
except AttributeError:
self.__cog_cleaned_doc__ = cleaned = inspect.getdoc(self)
return cleaned
def walk_commands(self): def walk_commands(self):
"""An iterator that recursively walks through this cog's commands and subcommands.""" """An iterator that recursively walks through this cog's commands and subcommands."""
from .core import GroupMixin from .core import GroupMixin