aboutsummaryrefslogtreecommitdiff
path: root/discord/permissions.py
diff options
context:
space:
mode:
authorRapptz <[email protected]>2016-01-14 12:24:59 -0500
committerRapptz <[email protected]>2016-01-14 12:24:59 -0500
commit855fa7e553bf490ee1ec0e7d74043c61cc41c0ef (patch)
tree1edad964feb4dc355341bcdad2f54190af8dea84 /discord/permissions.py
parent[commands] Change behaviour of consume rest to be more useful. (diff)
downloaddiscord.py-855fa7e553bf490ee1ec0e7d74043c61cc41c0ef.tar.xz
discord.py-855fa7e553bf490ee1ec0e7d74043c61cc41c0ef.zip
Documentation fixes for Permissions related code.
Diffstat (limited to 'discord/permissions.py')
-rw-r--r--discord/permissions.py18
1 files changed, 9 insertions, 9 deletions
diff --git a/discord/permissions.py b/discord/permissions.py
index ce50abfe..94b89a24 100644
--- a/discord/permissions.py
+++ b/discord/permissions.py
@@ -39,15 +39,15 @@ class Permissions:
| hash(x) | Return the permission's hash. |
+-----------+------------------------------------------+
+ The properties provided are two way. You can set and retrieve individual bits using the properties as if they
+ were regular bools. This allows you to edit permissions.
+
Attributes
-----------
value
The raw value. This value is a bit array field of a 32-bit integer
representing the currently available permissions. You should query
permissions via the properties rather than using this raw value.
-
- The properties provided are two way. You can set and retrieve individual bits using the properties as if they
- were regular bools. This allows you to edit permissions.
"""
__slots__ = [ 'value' ]
@@ -65,19 +65,19 @@ class Permissions:
@classmethod
def none(cls):
- """A factory method that creates a :class:`Permission` with all
+ """A factory method that creates a :class:`Permissions` with all
permissions set to False."""
return cls(0)
@classmethod
def all(cls):
- """A factory method that creates a :class:`Permission` with all
+ """A factory method that creates a :class:`Permissions` with all
permissions set to True."""
return cls(0b00000011111100111111110000111111)
@classmethod
def all_channel(cls):
- """A :class:`Permission` with all channel-specific permissions set to
+ """A :class:`Permissions` with all channel-specific permissions set to
True and the server-specific ones set to False. The server-specific
permissions are currently:
@@ -89,19 +89,19 @@ class Permissions:
@classmethod
def general(cls):
- """A factory method that creates a :class:`Permission` with all
+ """A factory method that creates a :class:`Permissions` with all
"General" permissions set to True."""
return cls(0b00000000000000000000000000111111)
@classmethod
def text(cls):
- """A factory method that creates a :class:`Permission` with all
+ """A factory method that creates a :class:`Permissions` with all
"Text" permissions set to True."""
return cls(0b00000000000000111111110000000000)
@classmethod
def voice(cls):
- """A factory method that creates a :class:`Permission` with all
+ """A factory method that creates a :class:`Permissions` with all
"Voice" permissions set to True."""
return cls(0b00000011111100000000000000000000)