aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRapptz <[email protected]>2016-03-25 22:51:03 -0400
committerRapptz <[email protected]>2016-03-25 22:51:03 -0400
commit1a98e9235aafbafb4c8dbdefadb6d4a7df98d55d (patch)
tree659cfbe4d863b55ade4d43b4361bb2b0ef596070
parentServer.icon_url uses API url instead of the CDN. (diff)
downloaddiscord.py-1a98e9235aafbafb4c8dbdefadb6d4a7df98d55d.tar.xz
discord.py-1a98e9235aafbafb4c8dbdefadb6d4a7df98d55d.zip
Clarify Channel.position documentation.
-rw-r--r--discord/channel.py5
1 files changed, 4 insertions, 1 deletions
diff --git a/discord/channel.py b/discord/channel.py
index 11f6b722..b63a27c8 100644
--- a/discord/channel.py
+++ b/discord/channel.py
@@ -62,7 +62,10 @@ class Channel(Hashable):
is_private : bool
``True`` if the channel is a private channel (i.e. PM). ``False`` in this case.
position : int
- The position in the channel list.
+ The position in the channel list. This is a number that starts at 0. e.g. the
+ top channel is position 0. The position varies depending on being a voice channel
+ or a text channel, so a 0 position voice channel is on top of the voice channel
+ list.
type : :class:`ChannelType`
The channel type. There is a chance that the type will be ``str`` if
the channel type is not within the ones recognised by the enumerator.