diff options
| author | Rapptz <[email protected]> | 2016-08-14 13:52:08 -0400 |
|---|---|---|
| committer | Rapptz <[email protected]> | 2016-08-14 13:52:08 -0400 |
| commit | b2808b2abde27322cabb82b6794b231e4226ca43 (patch) | |
| tree | 741a7491b97334b1433a39eb6c3d0234eb4397bb | |
| parent | Explain cases where the on_message_edit event can be triggered. (diff) | |
| download | discord.py-b2808b2abde27322cabb82b6794b231e4226ca43.tar.xz discord.py-b2808b2abde27322cabb82b6794b231e4226ca43.zip | |
Document what it means that an object is not edited in-place explicitly
This seems to be a very common question regarding the docs so might as
well document exactly what this means rather than using cryptic and
confusing wording.
| -rw-r--r-- | discord/client.py | 33 |
1 files changed, 22 insertions, 11 deletions
diff --git a/discord/client.py b/discord/client.py index 53cb1802..e9ec0c56 100644 --- a/discord/client.py +++ b/discord/client.py @@ -1081,6 +1081,9 @@ class Client: The new_content must be able to be transformed into a string via ``str(new_content)``. + The :class:`Message` object is not directly modified afterwards until the + corresponding WebSocket event is received. + Parameters ----------- message : :class:`Message` @@ -1453,7 +1456,8 @@ class Client: If a bot account is used then the password field is optional, otherwise it is required. - The profile is **not** edited in place. + The :attr:`Client.user` object is not modified directly afterwards until the + corresponding WebSocket event is received. Note ----- @@ -1596,7 +1600,8 @@ class Client: To move the channel's position use :meth:`move_channel` instead. - The channel is **not** edited in-place. + The :class:`Channel` object is not directly modified afterwards until the + corresponding WebSocket event is received. Parameters ---------- @@ -1633,7 +1638,8 @@ class Client: Moves the specified :class:`Channel` to the given position in the GUI. Note that voice channels and text channels have different position values. - This does **not** edit the channel ordering in place. + The :class:`Channel` object is not directly modified afterwards until the + corresponding WebSocket event is received. .. warning:: @@ -1903,7 +1909,8 @@ class Client: You must have the proper permissions to edit the server. - The server is **not** edited in-place. + The :class:`Server` object is not directly modified afterwards until the + corresponding WebSocket event is received. Parameters ---------- @@ -2254,7 +2261,8 @@ class Client: Moves the specified :class:`Role` to the given position in the :class:`Server`. - This does **not** edit the role ordering in place. + The :class:`Role` object is not directly modified afterwards until the + corresponding WebSocket event is received. Parameters ----------- @@ -2304,7 +2312,8 @@ class Client: Edits the specified :class:`Role` for the entire :class:`Server`. - This does **not** edit the role in place. + The :class:`Role` object is not directly modified afterwards until the + corresponding WebSocket event is received. All fields except ``server`` and ``role`` are optional. To change the position of a role, use :func:`move_role` instead. @@ -2386,8 +2395,8 @@ class Client: You must have the proper permissions to use this function. - This method **appends** a role to a member but does **not** do it - in-place. + The :class:`Member` object is not directly modified afterwards until the + corresponding WebSocket event is received. Parameters ----------- @@ -2415,7 +2424,8 @@ class Client: You must have the proper permissions to use this function. - This method does **not** edit the member in-place. + The :class:`Member` object is not directly modified afterwards until the + corresponding WebSocket event is received. Parameters ----------- @@ -2453,7 +2463,8 @@ class Client: call is ``client.replace_roles(member, d, e, c)`` then the member has the roles ``[d, e, c]``. - This method does **not** edit the member in-place. + The :class:`Member` object is not directly modified afterwards until the + corresponding WebSocket event is received. Parameters ----------- @@ -2599,7 +2610,7 @@ class Client: Note ----- - You cannot pass in a :class:`Object` in place of a :class:`Channel` + You cannot pass in a :class:`Object` instead of a :class:`Channel` object in this function. Parameters |