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

Fix permissions-based docstrings to be more consistent

Browse Source
This commit is contained in:
Steve C
2022-09-17 14:07:39 -04:00
committed by GitHub
parent a53b609e37
commit ce06beeb6c
19 changed files with 104 additions and 155 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
discord/message.py
View File

@ -771,8 +771,7 @@ class PartialMessage(Hashable):
Deletes the message.
Your own messages could be deleted without any proper permissions. However to
delete other people's messages, you need the :attr:`~Permissions.manage_messages`
permission.
delete other people's messages, you must have :attr:`~Permissions.manage_messages`.
.. versionchanged:: 1.1
Added the new ``delay`` keyword-only parameter.
@ -947,10 +946,10 @@ class PartialMessage(Hashable):
Publishes this message to your announcement channel.
You must have the :attr:`~Permissions.send_messages` permission to do this.
You must have :attr:`~Permissions.send_messages` to do this.
If the message is not your own then the :attr:`~Permissions.manage_messages`
permission is also needed.
If the message is not your own then :attr:`~Permissions.manage_messages`
is also needed.
Raises
-------
@ -967,7 +966,7 @@ class PartialMessage(Hashable):
Pins the message.
You must have the :attr:`~Permissions.manage_messages` permission to do
You must have :attr:`~Permissions.manage_messages` to do
this in a non-private channel context.
Parameters
@ -997,7 +996,7 @@ class PartialMessage(Hashable):
Unpins the message.
You must have the :attr:`~Permissions.manage_messages` permission to do
You must have :attr:`~Permissions.manage_messages` to do
this in a non-private channel context.
Parameters
@ -1028,9 +1027,9 @@ class PartialMessage(Hashable):
The emoji may be a unicode emoji or a custom guild :class:`Emoji`.
You must have the :attr:`~Permissions.read_message_history` permission
to use this. If nobody else has reacted to the message using this
emoji, the :attr:`~Permissions.add_reactions` permission is required.
You must have :attr:`~Permissions.read_message_history`
to do this. If nobody else has reacted to the message using this
emoji, :attr:`~Permissions.add_reactions` is required.
.. versionchanged:: 2.0
@ -1068,7 +1067,7 @@ class PartialMessage(Hashable):
The emoji may be a unicode emoji or a custom guild :class:`Emoji`.
If the reaction is not your own (i.e. ``member`` parameter is not you) then
the :attr:`~Permissions.manage_messages` permission is needed.
:attr:`~Permissions.manage_messages` is needed.
The ``member`` parameter must represent a member and meet
the :class:`abc.Snowflake` abc.
@ -1110,7 +1109,7 @@ class PartialMessage(Hashable):
The emoji may be a unicode emoji or a custom guild :class:`Emoji`.
You need the :attr:`~Permissions.manage_messages` permission to use this.
You must have :attr:`~Permissions.manage_messages` to do this.
.. versionadded:: 1.3
@ -1143,7 +1142,7 @@ class PartialMessage(Hashable):
Removes all the reactions from the message.
You need the :attr:`~Permissions.manage_messages` permission to use this.
You must have :attr:`~Permissions.manage_messages` to do this.
Raises
--------