matthew/enhanced-discord.py
1
0
Fork 0
Code Issues 4 Pull Requests 21 Projects Releases Wiki Activity

Document what it means that an object is not edited in-place explicitly

Browse Source 
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.
This commit is contained in:
Rapptz 2016-08-14 13:52:08 -04:00
parent 83c7ba612e
commit b2808b2abd
1 changed files with 22 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
discord/client.py
View File

@ -1081,6 +1081,9 @@ class Client:
The new_content must be able to be transformed into a string via ``str(new_content)``. 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 Parameters
----------- -----------
message : :class:`Message` message : :class:`Message`
@ -1453,7 +1456,8 @@ class Client:
If a bot account is used then the password field is optional, If a bot account is used then the password field is optional,
otherwise it is required. 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 Note
----- -----
@ -1596,7 +1600,8 @@ class Client:
To move the channel's position use :meth:`move_channel` instead. 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 Parameters
---------- ----------
@ -1633,7 +1638,8 @@ class Client:
Moves the specified :class:`Channel` to the given position in the GUI. Moves the specified :class:`Channel` to the given position in the GUI.
Note that voice channels and text channels have different position values. 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:: .. warning::
@ -1903,7 +1909,8 @@ class Client:
You must have the proper permissions to edit the server. 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 Parameters
---------- ----------
@ -2254,7 +2261,8 @@ class Client:
Moves the specified :class:`Role` to the given position in the :class:`Server`. 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 Parameters
----------- -----------
@ -2304,7 +2312,8 @@ class Client:
Edits the specified :class:`Role` for the entire :class:`Server`. 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 All fields except ``server`` and ``role`` are optional. To change
the position of a role, use :func:`move_role` instead. 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. You must have the proper permissions to use this function.
This method **appends** a role to a member but does **not** do it The :class:`Member` object is not directly modified afterwards until the
in-place. corresponding WebSocket event is received.
Parameters Parameters
----------- -----------
@ -2415,7 +2424,8 @@ class Client:
You must have the proper permissions to use this function. 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 Parameters
----------- -----------
@ -2453,7 +2463,8 @@ class Client:
call is ``client.replace_roles(member, d, e, c)`` then call is ``client.replace_roles(member, d, e, c)`` then
the member has the roles ``[d, e, c]``. 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 Parameters
----------- -----------
@ -2599,7 +2610,7 @@ class Client:
Note 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. object in this function.
Parameters Parameters