Document the breaking change with the new dictionary storage change.

Since the only things dict views support are iteration we should
advise people who want the old behaviour to change it to a list.
This commit is contained in:
Rapptz
2016-01-08 14:03:11 -05:00
parent 6d5175ad9a
commit a1a47c6f38
3 changed files with 41 additions and 4 deletions

View File

@ -88,9 +88,9 @@ class Client:
Represents the current voice connection. None if you are not connected
to a voice channel. To connect to voice use :meth:`join_voice_channel`.
To query the voice connection state use :meth:`is_voice_connected`.
servers : list of :class:`Server`
servers : iterable of :class:`Server`
The servers that the connected client is a member of.
private_channels : list of :class:`PrivateChannel`
private_channels : iterable of :class:`PrivateChannel`
The private channels that the connected client is participating on.
messages
A deque_ of :class:`Message` that the client has received from all

View File

@ -67,9 +67,9 @@ class Server(Hashable):
afk_channel : :class:`Channel`
The channel that denotes the AFK channel. None if it doesn't exist.
members
A list of :class:`Member` that are currently on the server.
An iterable of :class:`Member` that are currently on the server.
channels
A list of :class:`Channel` that are currently on the server.
An iterable of :class:`Channel` that are currently on the server.
icon : str
The server's icon.
id : str