Fixes various documentation errors/inconsistencies

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

View File

@ -472,7 +472,7 @@ class GuildChannel:
Deletes the channel.
You must have Manage Channel permission to use this.
You must have :attr:`~.Permissions.manage_channels` permission to use this.
Parameters
-----------
@ -510,7 +510,7 @@ class GuildChannel:
If the ``overwrite`` parameter is ``None``, then the permission
overwrites are deleted.
You must have :attr:`Permissions.manage_roles` permission to use this.
You must have the :attr:`~Permissions.manage_roles` permission to use this.
Examples
----------
@ -592,6 +592,9 @@ class GuildChannel:
Creates an instant invite.
You must have :attr:`~.Permissions.create_instant_invite` permission to
do this.
Parameters
------------
max_age : int
@ -630,7 +633,7 @@ class GuildChannel:
Returns a list of all active instant invites from this channel.
You must have proper permissions to get this information.
You must have :attr:`~.Permissions.manage_guild` to get this information.
Raises
-------
@ -860,7 +863,7 @@ class Messageable(metaclass=abc.ABCMeta):
def history(self, *, limit=100, before=None, after=None, around=None, reverse=None):
"""Return an :class:`AsyncIterator` that enables receiving the destination's message history.
You must have :attr:`~Permissions.read_message_history` permissions to use this.
You must have :attr:`~.Permissions.read_message_history` permissions to use this.
All parameters are optional.