aboutsummaryrefslogtreecommitdiff
path: root/discord/channel.py
diff options
context:
space:
mode:
authorSebastian Law <[email protected]>2021-03-29 20:52:14 -0700
committerGitHub <[email protected]>2021-03-29 23:52:14 -0400
commitd6501159e7b765a526c94b4d83524c127ad4b22f (patch)
tree3bf20620c7ee6d9e5851e6f5a2b5009c2caf62c6 /discord/channel.py
parent[commands] Add support for stripping whitespace after the prefix (diff)
downloaddiscord.py-d6501159e7b765a526c94b4d83524c127ad4b22f.tar.xz
discord.py-d6501159e7b765a526c94b4d83524c127ad4b22f.zip
[docs] copy signature from overridden and inherited methods
Diffstat (limited to 'discord/channel.py')
-rw-r--r--discord/channel.py21
1 files changed, 7 insertions, 14 deletions
diff --git a/discord/channel.py b/discord/channel.py
index 7a5b9548..e63709d6 100644
--- a/discord/channel.py
+++ b/discord/channel.py
@@ -141,6 +141,7 @@ class TextChannel(discord.abc.Messageable, discord.abc.GuildChannel, Hashable):
def _sorting_bucket(self):
return ChannelType.text.value
+ @utils.copy_doc(discord.abc.GuildChannel.permissions_for)
def permissions_for(self, member):
base = super().permissions_for(member)
@@ -149,8 +150,6 @@ class TextChannel(discord.abc.Messageable, discord.abc.GuildChannel, Hashable):
base.value &= ~denied.value
return base
- permissions_for.__doc__ = discord.abc.GuildChannel.permissions_for.__doc__
-
@property
def members(self):
"""List[:class:`Member`]: Returns all members that can see this channel."""
@@ -240,6 +239,7 @@ class TextChannel(discord.abc.Messageable, discord.abc.GuildChannel, Hashable):
"""
await self._edit(options, reason=reason)
+ @utils.copy_doc(discord.abc.GuildChannel.clone)
async def clone(self, *, name=None, reason=None):
return await self._clone_impl({
'topic': self.topic,
@@ -247,8 +247,6 @@ class TextChannel(discord.abc.Messageable, discord.abc.GuildChannel, Hashable):
'rate_limit_per_user': self.slowmode_delay
}, name=name, reason=reason)
- clone.__doc__ = discord.abc.GuildChannel.clone.__doc__
-
async def delete_messages(self, messages):
"""|coro|
@@ -651,6 +649,7 @@ class VoiceChannel(discord.abc.Connectable, discord.abc.GuildChannel, Hashable):
"""
return {key: value for key, value in self.guild._voice_states.items() if value.channel.id == self.id}
+ @utils.copy_doc(discord.abc.GuildChannel.permissions_for)
def permissions_for(self, member):
base = super().permissions_for(member)
@@ -662,16 +661,13 @@ class VoiceChannel(discord.abc.Connectable, discord.abc.GuildChannel, Hashable):
base.value &= ~denied.value
return base
- permissions_for.__doc__ = discord.abc.GuildChannel.permissions_for.__doc__
-
+ @utils.copy_doc(discord.abc.GuildChannel.clone)
async def clone(self, *, name=None, reason=None):
return await self._clone_impl({
'bitrate': self.bitrate,
'user_limit': self.user_limit
}, name=name, reason=reason)
- clone.__doc__ = discord.abc.GuildChannel.clone.__doc__
-
async def edit(self, *, reason=None, **options):
"""|coro|
@@ -784,13 +780,12 @@ class CategoryChannel(discord.abc.GuildChannel, Hashable):
""":class:`bool`: Checks if the category is NSFW."""
return self.nsfw
+ @utils.copy_doc(discord.abc.GuildChannel.clone)
async def clone(self, *, name=None, reason=None):
return await self._clone_impl({
'nsfw': self.nsfw
}, name=name, reason=reason)
- clone.__doc__ = discord.abc.GuildChannel.clone.__doc__
-
async def edit(self, *, reason=None, **options):
"""|coro|
@@ -946,6 +941,7 @@ class StoreChannel(discord.abc.GuildChannel, Hashable):
""":class:`ChannelType`: The channel's Discord type."""
return ChannelType.store
+ @utils.copy_doc(discord.abc.GuildChannel.permissions_for)
def permissions_for(self, member):
base = super().permissions_for(member)
@@ -954,19 +950,16 @@ class StoreChannel(discord.abc.GuildChannel, Hashable):
base.value &= ~denied.value
return base
- permissions_for.__doc__ = discord.abc.GuildChannel.permissions_for.__doc__
-
def is_nsfw(self):
""":class:`bool`: Checks if the channel is NSFW."""
return self.nsfw
+ @utils.copy_doc(discord.abc.GuildChannel.clone)
async def clone(self, *, name=None, reason=None):
return await self._clone_impl({
'nsfw': self.nsfw
}, name=name, reason=reason)
- clone.__doc__ = discord.abc.GuildChannel.clone.__doc__
-
async def edit(self, *, reason=None, **options):
"""|coro|