aboutsummaryrefslogtreecommitdiff
path: root/discord/role.py
diff options
context:
space:
mode:
authorRapptz <[email protected]>2017-05-13 18:48:14 -0400
committerRapptz <[email protected]>2017-05-13 18:48:14 -0400
commitf73eb087c99a0ee73b9a46500225464ab866c625 (patch)
treec08643f1aa5add45d95f934422b1fc8fd35b1b33 /discord/role.py
parentAdd Colour.blurple and Colour.greyple. (diff)
downloaddiscord.py-f73eb087c99a0ee73b9a46500225464ab866c625.tar.xz
discord.py-f73eb087c99a0ee73b9a46500225464ab866c625.zip
Use describe instead of tables for supported operations.
Diffstat (limited to 'discord/role.py')
-rw-r--r--discord/role.py52
1 files changed, 31 insertions, 21 deletions
diff --git a/discord/role.py b/discord/role.py
index 088a076b..d19a5bec 100644
--- a/discord/role.py
+++ b/discord/role.py
@@ -35,27 +35,37 @@ from .utils import snowflake_time
class Role(Hashable):
"""Represents a Discord role in a :class:`Guild`.
- Supported Operations:
-
- +-----------+------------------------------------------------------------------+
- | Operation | Description |
- +===========+==================================================================+
- | x == y | Checks if two roles are equal. |
- +-----------+------------------------------------------------------------------+
- | x != y | Checks if two roles are not equal. |
- +-----------+------------------------------------------------------------------+
- | x > y | Checks if a role is higher than another in the hierarchy. |
- +-----------+------------------------------------------------------------------+
- | x < y | Checks if a role is lower than another in the hierarchy. |
- +-----------+------------------------------------------------------------------+
- | x >= y | Checks if a role is higher or equal to another in the hierarchy. |
- +-----------+------------------------------------------------------------------+
- | x <= y | Checks if a role is lower or equal to another in the hierarchy. |
- +-----------+------------------------------------------------------------------+
- | hash(x) | Return the role's hash. |
- +-----------+------------------------------------------------------------------+
- | str(x) | Returns the role's name. |
- +-----------+------------------------------------------------------------------+
+ .. describe:: x == y
+
+ Checks if two roles are equal.
+
+ .. describe:: x != y
+
+ Checks if two roles are not equal.
+
+ .. describe:: x > y
+
+ Checks if a role is higher than another in the hierarchy.
+
+ .. describe:: x < y
+
+ Checks if a role is lower than another in the hierarchy.
+
+ .. describe:: x >= y
+
+ Checks if a role is higher or equal to another in the hierarchy.
+
+ .. describe:: x <= y
+
+ Checks if a role is lower or equal to another in the hierarchy.
+
+ .. describe:: hash(x)
+
+ Return the role's hash.
+
+ .. describe:: str(x)
+
+ Returns the role's name.
Attributes
----------