mirror of
https://github.com/Rapptz/discord.py.git
synced 2025-06-07 04:17:16 +00:00
[commands] Document exceptions being ignored in teardown and cog_unload
Co-authored-by: Josh <josh.ja.butt@gmail.com>
This commit is contained in:
parent
0e727d8e6d
commit
2ab6541715
@ -550,6 +550,8 @@ class Cog(metaclass=CogMeta):
|
|||||||
|
|
||||||
Subclasses must replace this if they want special unloading behaviour.
|
Subclasses must replace this if they want special unloading behaviour.
|
||||||
|
|
||||||
|
Exceptions raised in this method are ignored during extension unloading.
|
||||||
|
|
||||||
.. versionchanged:: 2.0
|
.. versionchanged:: 2.0
|
||||||
|
|
||||||
This method can now be a :term:`coroutine`.
|
This method can now be a :term:`coroutine`.
|
||||||
|
@ -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.
|
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
|
.. code-block:: python3
|
||||||
:caption: basic_ext.py
|
:caption: basic_ext.py
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user