Browse Source

Documentation fixes for role related functions.

pull/224/merge
Rapptz 9 years ago
parent
commit
aa45bce212
  1. 16
      discord/client.py

16
discord/client.py

@ -2226,18 +2226,12 @@ class Client:
This does **not** edit the role in place. This does **not** edit the role in place.
All fields except ``server`` and ``role`` are optional. All fields except ``server`` and ``role`` are optional. To change
the position of a role, use :func:`move_role` instead.
.. versionchanged:: 0.8.0 .. versionchanged:: 0.8.0
Editing now uses keyword arguments instead of editing the :class:`Role` object directly. Editing now uses keyword arguments instead of editing the :class:`Role` object directly.
Note
-----
At the moment, the Discord API allows you to set the colour to any
RGB value. This might change in the future so it is recommended that
you use the constants in the :class:`Colour` instead such as
:meth:`Colour.green`.
Parameters Parameters
----------- -----------
server : :class:`Server` server : :class:`Server`
@ -2286,8 +2280,6 @@ class Client:
Deletes the specified :class:`Role` for the entire :class:`Server`. Deletes the specified :class:`Role` for the entire :class:`Server`.
Works in a similar matter to :func:`edit_role`.
Parameters Parameters
----------- -----------
server : :class:`Server` server : :class:`Server`
@ -2359,7 +2351,7 @@ 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** do edit the member in-place. This method does **not** edit the member in-place.
Parameters Parameters
----------- -----------
@ -2402,7 +2394,7 @@ 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** do edit the member in-place. This method does **not** edit the member in-place.
Parameters Parameters
----------- -----------

Loading…
Cancel
Save