aboutsummaryrefslogtreecommitdiff
path: root/discord/channel.py
diff options
context:
space:
mode:
authorTobotimus <[email protected]>2018-01-06 17:21:56 -0500
committerRapptz <[email protected]>2018-01-06 17:23:59 -0500
commit3112e1c17e7859adf6d13ed844f4c636b4bc30d8 (patch)
tree70d7aafca549a8c245ee4fdab774e1ab5302d531 /discord/channel.py
parent[commands] Fix MissingRequiredArgument param handling (diff)
downloaddiscord.py-3112e1c17e7859adf6d13ed844f4c636b4bc30d8.tar.xz
discord.py-3112e1c17e7859adf6d13ed844f4c636b4bc30d8.zip
Add intersphinx
Diffstat (limited to 'discord/channel.py')
-rw-r--r--discord/channel.py40
1 files changed, 20 insertions, 20 deletions
diff --git a/discord/channel.py b/discord/channel.py
index a615f5ad..93358e14 100644
--- a/discord/channel.py
+++ b/discord/channel.py
@@ -65,17 +65,17 @@ class TextChannel(discord.abc.Messageable, discord.abc.GuildChannel, Hashable):
Attributes
-----------
- name: str
+ name: :class:`str`
The channel name.
guild: :class:`Guild`
The guild the channel belongs to.
- id: int
+ id: :class:`int`
The channel ID.
- category_id: int
+ category_id: :class:`int`
The category channel ID this channel belongs to.
- topic: Optional[str]
+ topic: Optional[:class:`str`]
The channel's topic. None if it doesn't exist.
- position: int
+ position: :class:`int`
The position in the channel list. This is a number that starts at 0. e.g. the
top channel is position 0.
"""
@@ -116,7 +116,7 @@ class TextChannel(discord.abc.Messageable, discord.abc.GuildChannel, Hashable):
@property
def members(self):
- """Returns a list of :class:`Member` that can see this channel."""
+ """Returns a :class:`list` of :class:`Member` that can see this channel."""
return [m for m in self.guild.members if self.permissions_for(m).read_messages]
def is_nsfw(self):
@@ -404,20 +404,20 @@ class VoiceChannel(discord.abc.Connectable, discord.abc.GuildChannel, Hashable):
Attributes
-----------
- name: str
+ name: :class:`str`
The channel name.
guild: :class:`Guild`
The guild the channel belongs to.
- id: int
+ id: :class:`int`
The channel ID.
- category_id: int
+ category_id: :class:`int`
The category channel ID this channel belongs to.
- position: int
+ position: :class:`int`
The position in the channel list. This is a number that starts at 0. e.g. the
top channel is position 0.
- bitrate: int
+ bitrate: :class:`int`
The channel's preferred audio bitrate in bits per second.
- user_limit: int
+ user_limit: :class:`int`
The channel's limit for number of members that can be in a voice channel.
"""
@@ -521,13 +521,13 @@ class CategoryChannel(discord.abc.GuildChannel, Hashable):
Attributes
-----------
- name: str
+ name: :class:`str`
The category name.
guild: :class:`Guild`
The guild the category belongs to.
- id: int
+ id: :class:`int`
The category channel ID.
- position: int
+ position: :class:`int`
The position in the category list. This is a number that starts at 0. e.g. the
top category is position 0.
"""
@@ -637,7 +637,7 @@ class DMChannel(discord.abc.Messageable, Hashable):
The user you are participating with in the direct message channel.
me: :class:`ClientUser`
The user presenting yourself.
- id: int
+ id: :class:`int`
The direct message channel ID.
"""
@@ -716,17 +716,17 @@ class GroupChannel(discord.abc.Messageable, Hashable):
Attributes
----------
- recipients: list of :class:`User`
+ recipients: :class:`list` of :class:`User`
The users you are participating with in the group channel.
me: :class:`ClientUser`
The user presenting yourself.
- id: int
+ id: :class:`int`
The group channel ID.
owner: :class:`User`
The user that owns the group channel.
- icon: Optional[str]
+ icon: Optional[:class:`str`]
The group channel's icon hash if provided.
- name: Optional[str]
+ name: Optional[:class:`str`]
The group channel's name if provided.
"""