mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-09-08 10:53:10 +00:00
Code Issues Projects Releases Wiki Activity

Organise documentation

Browse Source
This commit is contained in:
NCPlayz
2019-03-16 21:43:55 +00:00
committed by Rapptz
parent 5e65ec978c
commit fb02191b80
30 changed files with 417 additions and 419 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
discord/member.py
View File

@ -366,7 +366,7 @@ class Member(discord.abc.Messageable, _BaseUser):
Parameters
-----------
channel
channel: :class:`Channel`
The channel to check your permissions for.
"""
return channel.permissions_for(self)
@ -457,17 +457,17 @@ class Member(discord.abc.Messageable, _BaseUser):
Parameters
-----------
nick: str
nick: Optional[:class:`str`]
The member's new nickname. Use ``None`` to remove the nickname.
mute: bool
mute: Optional[:class:`bool`]
Indicates if the member should be guild muted or un-muted.
deafen: bool
deafen: Optional[:class:`bool`]
Indicates if the member should be guild deafened or un-deafened.
roles: List[:class:`Roles`]
roles: Optional[List[:class:`Roles`]]
The member's new list of roles. This *replaces* the roles.
voice_channel: :class:`VoiceChannel`
voice_channel: Optional[:class:`VoiceChannel`]
The voice channel to move the member to.
reason: Optional[str]
reason: Optional[:class:`str`]
The reason for editing this member. Shows up on the audit log.
Raises
@ -533,7 +533,7 @@ class Member(discord.abc.Messageable, _BaseUser):
-----------
channel: :class:`VoiceChannel`
The new voice channel to move the member to.
reason: Optional[str]
reason: Optional[:class:`str`]
The reason for doing this action. Shows up on the audit log.
"""
await self.edit(voice_channel=channel, reason=reason)
@ -548,10 +548,10 @@ class Member(discord.abc.Messageable, _BaseUser):
Parameters
-----------
\*roles
\*roles: :class:`Snowflake`
An argument list of :class:`abc.Snowflake` representing a :class:`Role`
to give to the member.
reason: Optional[str]
reason: Optional[:class:`str`]
The reason for adding these roles. Shows up on the audit log.
atomic: bool
Whether to atomically add roles. This will ensure that multiple
@ -586,12 +586,12 @@ class Member(discord.abc.Messageable, _BaseUser):
Parameters
-----------
\*roles
\*roles: :class:`Snowflake`
An argument list of :class:`abc.Snowflake` representing a :class:`Role`
to remove from the member.
reason: Optional[str]
reason: Optional[:class:`str`]
The reason for removing these roles. Shows up on the audit log.
atomic: bool
atomic: :class:`bool`
Whether to atomically remove roles. This will ensure that multiple
operations will always be applied regardless of the current
state of the cache.