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

Fixes various documentation errors/inconsistencies

Browse Source 
Mostly dealing with permissions, also fixes Raw Events inclusion.
This commit is contained in:
Steve C
2018-05-10 03:34:13 -04:00
committed by Rapptz
parent 0dafdedc65
commit 0e945915b7
9 changed files with 59 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
discord/guild.py
View File

@ -364,7 +364,7 @@ class Guild(Hashable):
@property
def members(self):
"""List[:class:`Member`]: A list of members that belongs to this guild."""
"""List[:class:`Member`]: A list of members that belong to this guild."""
return list(self._members.values())
def get_member(self, user_id):
@ -549,7 +549,8 @@ class Guild(Hashable):
Creates a :class:`TextChannel` for the guild.
Note that you need the proper permissions to create the channel.
Note that you need the :attr:`~Permissions.manage_channels` permission
to create the channel.
The ``overwrites`` parameter can be used to create a 'secret'
channel upon creation. This parameter expects a :class:`dict` of
@ -807,7 +808,7 @@ class Guild(Hashable):
with a ``user`` and ``reason`` field. See :meth:`bans` for more
information.
You must have :attr:`~Permissions.ban_members` permission
You must have the :attr:`~Permissions.ban_members` permission
to get this information.
Parameters
@ -841,12 +842,12 @@ class Guild(Hashable):
Retrieves all the users that are banned from the guild.
This coroutine returns a :class:`list` of BanEntry objects. Which is a
This coroutine returns a :class:`list` of BanEntry objects, which is a
namedtuple with a ``user`` field to denote the :class:`User`
that got banned along with a ``reason`` field specifying
why the user was banned that could be set to ``None``.
You must have :attr:`~Permissions.ban_members` permission
You must have the :attr:`~Permissions.ban_members` permission
to get this information.
Raises
@ -972,7 +973,8 @@ class Guild(Hashable):
Returns a list of all active instant invites from the guild.
You must have :attr:`~Permissions.manage_guild` to get this information.
You must have the :attr:`~Permissions.manage_guild` permission to get
this information.
Raises
-------
@ -1005,6 +1007,9 @@ class Guild(Hashable):
There is currently a limit of 50 local emotes per guild.
You must have the :attr:`~Permissions.manage_emojis` permission to
do this.
Note that bot accounts can only edit and delete emojis they have created.
Parameters
@ -1042,6 +1047,9 @@ class Guild(Hashable):
All fields are optional.
You must have the :attr:`~Permissions.manage_roles` permission to
do this.
Parameters
-----------
name: str
@ -1108,7 +1116,7 @@ class Guild(Hashable):
The user must meet the :class:`abc.Snowflake` abc.
You must have :attr:`Permissions.kick_members` permissions to
You must have the :attr:`~Permissions.kick_members` permission to
do this.
Parameters
@ -1135,7 +1143,7 @@ class Guild(Hashable):
The user must meet the :class:`abc.Snowflake` abc.
You must have :attr:`Permissions.ban_members` permissions to
You must have the :attr:`~Permissions.ban_members` permission to
do this.
Parameters
@ -1165,7 +1173,7 @@ class Guild(Hashable):
The user must meet the :class:`abc.Snowflake` abc.
You must have :attr:`Permissions.ban_members` permissions to
You must have the :attr:`~Permissions.ban_members` permission to
do this.
Parameters
@ -1193,7 +1201,8 @@ class Guild(Hashable):
The guild must be partnered, i.e. have 'VANITY_URL' in
:attr:`~Guild.features`.
You must have :attr:`Permissions.manage_guild` to use this as well.
You must have the :attr:`~Permissions.manage_guild` permission to use
this as well.
Returns
--------
@ -1246,7 +1255,7 @@ class Guild(Hashable):
def audit_logs(self, *, limit=100, before=None, after=None, reverse=None, user=None, action=None):
"""Return an :class:`AsyncIterator` that enables receiving the guild's audit logs.
You must have :attr:`Permissions.view_audit_logs` permission to use this.
You must have the :attr:`~Permissions.view_audit_log` permission to use this.
Parameters
-----------