mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-10-24 10:02:56 +00:00
Code Issues Projects Releases Wiki Activity

Add coro tag to docstrings that were missing it

Browse Source
This commit is contained in:
ster
2022-10-03 06:52:18 +09:00
committed by GitHub
parent dc34a8f1dc
commit 95b6bd8782
6 changed files with 31 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
discord/ext/commands/bot.py
View File

@@ -1059,7 +1059,9 @@ class BotBase(GroupMixin[None]):
await self._call_module_finalizers(lib, name)
async def reload_extension(self, name: str, *, package: Optional[str] = None) -> None:
"""Atomically reloads an extension.
"""|coro|
Atomically reloads an extension.
This replaces the extension with the same extension, only refreshed. This is
equivalent to a :meth:`unload_extension` followed by a :meth:`load_extension`

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

@@ -579,7 +579,9 @@ class Cog(metaclass=CogMeta):
@_cog_special_method
async def cog_command_error(self, ctx: Context[BotT], error: Exception) -> None:
"""A special method that is called whenever an error
"""|coro|
A special method that is called whenever an error
is dispatched inside this cog.
This is similar to :func:`.on_command_error` except only applying
@@ -598,7 +600,9 @@ class Cog(metaclass=CogMeta):
@_cog_special_method
async def cog_app_command_error(self, interaction: discord.Interaction, error: app_commands.AppCommandError) -> None:
"""A special method that is called whenever an error within
"""|coro|
A special method that is called whenever an error within
an application command is dispatched inside this cog.
This is similar to :func:`discord.app_commands.CommandTree.on_error` except
@@ -617,7 +621,9 @@ class Cog(metaclass=CogMeta):
@_cog_special_method
async def cog_before_invoke(self, ctx: Context[BotT]) -> None:
"""A special method that acts as a cog local pre-invoke hook.
"""|coro|
A special method that acts as a cog local pre-invoke hook.
This is similar to :meth:`.Command.before_invoke`.
@@ -632,7 +638,9 @@ class Cog(metaclass=CogMeta):
@_cog_special_method
async def cog_after_invoke(self, ctx: Context[BotT]) -> None:
"""A special method that acts as a cog local post-invoke hook.
"""|coro|
A special method that acts as a cog local post-invoke hook.
This is similar to :meth:`.Command.after_invoke`.

10
discord/ext/commands/help.py
View File

@@ -1172,7 +1172,10 @@ class DefaultHelpCommand(HelpCommand):
self.paginator.add_line(entry)
async def send_pages(self) -> None:
"""A helper utility to send the page output from :attr:`paginator` to the destination."""
"""|coro|
A helper utility to send the page output from :attr:`paginator` to the destination.
"""
destination = self.get_destination()
for page in self.paginator.pages:
await destination.send(page)
@@ -1334,7 +1337,10 @@ class MinimalHelpCommand(HelpCommand):
super().__init__(**options)
async def send_pages(self) -> None:
"""A helper utility to send the page output from :attr:`paginator` to the destination."""
"""|coro|
A helper utility to send the page output from :attr:`paginator` to the destination.
"""
destination = self.get_destination()
for page in self.paginator.pages:
await destination.send(page)