diff options
| author | Rapptz <[email protected]> | 2015-12-09 17:54:34 -0500 |
|---|---|---|
| committer | Rapptz <[email protected]> | 2015-12-09 17:54:34 -0500 |
| commit | da5d7581ee3eb1be78b5e5cc5835130dc4c39e75 (patch) | |
| tree | b3dc549b2420e91caf7fe923cd59227794c42b10 | |
| parent | Add enums to __init__.py (diff) | |
| download | discord.py-da5d7581ee3eb1be78b5e5cc5835130dc4c39e75.tar.xz discord.py-da5d7581ee3eb1be78b5e5cc5835130dc4c39e75.zip | |
Clear up documentation on passing discord.Object
| -rw-r--r-- | discord/client.py | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/discord/client.py b/discord/client.py index daec48e4..75fd1530 100644 --- a/discord/client.py +++ b/discord/client.py @@ -683,8 +683,11 @@ class Client: 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. 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` - instance then it is assumed to be the destination ID. + :meth:`Server.get_default_channel` and sending it there. + + 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 ``str`` being allowed was removed and replaced with :class:`Object`. |