From 27c6d2c923993b046b0da57cb934a8ec1899ce6e Mon Sep 17 00:00:00 2001 From: Rapptz Date: Thu, 14 Mar 2019 03:53:19 -0400 Subject: [PATCH] [commands] Add Cog.description to get the clean docstring. --- discord/ext/commands/cog.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/discord/ext/commands/cog.py b/discord/ext/commands/cog.py index afcfd9c50..425b63002 100644 --- a/discord/ext/commands/cog.py +++ b/discord/ext/commands/cog.py @@ -181,6 +181,15 @@ class Cog(metaclass=CogMeta): """:class:`str`: Returns the cog's specified name, not the class 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): """An iterator that recursively walks through this cog's commands and subcommands.""" from .core import GroupMixin