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

Clear up documentation on passing discord.Object

Browse Source
This commit is contained in:
Rapptz 2015-12-09 17:54:34 -05:00
parent 4e3301a57c
commit da5d7581ee
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
discord/client.py
View File

@ -683,8 +683,11 @@ class Client:
For convenience it could also be a :class:`User`. If it's a :class:`User` or :class:`PrivateChannel` For convenience it could also be a :class:`User`. If it's a :class:`User` or :class:`PrivateChannel`
then it sends the message via private message, otherwise it sends the message to the channel. then it sends the message via private message, otherwise it sends the message to the channel.
If the destination is a :class:`Server` then it's equivalent to calling If the destination is a :class:`Server` then it's equivalent to calling
:meth:`Server.get_default_channel` and sending it there. If it is a :class:`Object` :meth:`Server.get_default_channel` and sending it there.
instance then it is assumed to be the destination ID.
If it is a :class:`Object` instance then it is assumed to be the
destination ID. The destination ID is a *channel* so passing in a user
ID will not be a valid destination.
.. versionchanged:: 0.9.0 .. versionchanged:: 0.9.0
``str`` being allowed was removed and replaced with :class:`Object`. ``str`` being allowed was removed and replaced with :class:`Object`.