From 2ab6541715b8ffc97c8f787749c301d2721705ba Mon Sep 17 00:00:00 2001 From: Sebastian Law Date: Tue, 23 May 2023 17:31:49 -0700 Subject: [PATCH] [commands] Document exceptions being ignored in teardown and cog_unload Co-authored-by: Josh --- discord/ext/commands/cog.py | 2 ++ docs/ext/commands/extensions.rst | 2 ++ 2 files changed, 4 insertions(+) diff --git a/discord/ext/commands/cog.py b/discord/ext/commands/cog.py index 02136bce8..319f85b80 100644 --- a/discord/ext/commands/cog.py +++ b/discord/ext/commands/cog.py @@ -550,6 +550,8 @@ class Cog(metaclass=CogMeta): Subclasses must replace this if they want special unloading behaviour. + Exceptions raised in this method are ignored during extension unloading. + .. versionchanged:: 2.0 This method can now be a :term:`coroutine`. diff --git a/docs/ext/commands/extensions.rst b/docs/ext/commands/extensions.rst index 9351c9702..d03607845 100644 --- a/docs/ext/commands/extensions.rst +++ b/docs/ext/commands/extensions.rst @@ -54,6 +54,8 @@ Cleaning Up Although rare, sometimes an extension needs to clean-up or know when it's being unloaded. For cases like these, there is another entry point named ``teardown`` which is similar to ``setup`` except called when the extension is unloaded. +Exceptions raised in the ``teardown`` function are ignored, and the extension is still unloaded. + .. code-block:: python3 :caption: basic_ext.py