aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRapptz <[email protected]>2020-08-22 17:14:02 -0400
committerRapptz <[email protected]>2020-08-22 17:14:02 -0400
commit45752ab3543a95ffcb6fa866ca91c57b81a4b9a2 (patch)
tree720bf87ca9bcb8383d43c991f38067c91ada2399
parentFix hyperlink reference to PartialInviteChannel in Client (diff)
downloaddiscord.py-45752ab3543a95ffcb6fa866ca91c57b81a4b9a2.tar.xz
discord.py-45752ab3543a95ffcb6fa866ca91c57b81a4b9a2.zip
Document merging behaviour of AllowedMentions in Messageable.send
-rw-r--r--discord/abc.py7
1 files changed, 6 insertions, 1 deletions
diff --git a/discord/abc.py b/discord/abc.py
index 7704a5f8..251174f2 100644
--- a/discord/abc.py
+++ b/discord/abc.py
@@ -827,7 +827,12 @@ class Messageable(metaclass=abc.ABCMeta):
before deleting the message we just sent. If the deletion fails,
then it is silently ignored.
allowed_mentions: :class:`~discord.AllowedMentions`
- Controls the mentions being processed in this message.
+ Controls the mentions being processed in this message. If this is
+ passed, then the object is merged with :attr:`~discord.Client.allowed_mentions`.
+ The merging behaviour only overrides attributes that have been explicitly passed
+ to the object, otherwise it uses the attributes set in :attr:`~discord.Client.allowed_mentions`.
+ If no object is passed at all then the defaults given by :attr:`~discord.Client.allowed_mentions`
+ are used instead.
.. versionadded:: 1.4