aboutsummaryrefslogtreecommitdiff
path: root/discord/role.py
diff options
context:
space:
mode:
authorRapptz <[email protected]>2015-12-04 23:43:31 -0500
committerRapptz <[email protected]>2015-12-04 23:43:31 -0500
commit17171aaa6032060c7fa845fa275f80f2ffbc2421 (patch)
tree5e4e27bde897c6fe7aa764555131cb3eea87605c /discord/role.py
parentAdd server management commands. (diff)
downloaddiscord.py-17171aaa6032060c7fa845fa275f80f2ffbc2421.tar.xz
discord.py-17171aaa6032060c7fa845fa275f80f2ffbc2421.zip
Switch to NumPy style documentation.
Diffstat (limited to 'discord/role.py')
-rw-r--r--discord/role.py36
1 files changed, 14 insertions, 22 deletions
diff --git a/discord/role.py b/discord/role.py
index 376be2c9..3e43270d 100644
--- a/discord/role.py
+++ b/discord/role.py
@@ -30,31 +30,23 @@ from .colour import Colour
class Role(object):
"""Represents a Discord role in a :class:`Server`.
- Instance attributes:
-
- .. attribute:: id
-
+ Attributes
+ ----------
+ id : str
The ID for the role.
- .. attribute:: name
-
+ name : str
The name of the role.
- .. attribute:: permissions
-
- A :class:`Permissions` that represents the role's permissions.
- .. attribute:: color
- colour
-
- A :class:`Colour` representing the role colour.
- .. attribute:: hoist
-
- A boolean representing if the role will be displayed separately from other members.
- .. attribute:: position
-
+ permissions : :class:`Permissions`
+ Represents the role's permissions.
+ color : :class:`Colour`
+ Represents the role colour.
+ hoist : bool
+ Indicates if the role will be displayed separately from other members.
+ position : int
The position of the role. This number is usually positive.
- .. attribute:: managed
-
- A boolean indicating if the role is managed by the server through some form of integration
- such as Twitch.
+ managed : bool
+ Indicates if the role is managed by the server through some form of
+ integrations such as Twitch.
"""
def __init__(self, **kwargs):