MORE DOCUMENTATION KANYE BELIEVE IT

This commit is contained in:
hydrabolt
2015-09-27 20:02:41 +01:00
parent d27638b421
commit 2f52ca50bf
3 changed files with 16 additions and 2 deletions

View File

@@ -1,3 +1,5 @@
.. include:: ./vars.rst
Resolvable Documentation
========================
@@ -6,4 +8,12 @@ To be robust, discord.js needs to handle a wide amount of ambiguous data that is
Channel Resolvable
------------------
A Channel Resolvable is data that can be resolved to a channel ID. Here is what is currently supported:
A Channel Resolvable is data that can be resolved to a channel ID. Here is what is currently supported:
- A Channel_ object
- A Server_ object (the #general channel of the server will be used)
- A String_ representing the channel ID
- A Message_ (the channel the message was sent in will be used)
- A User_ (will get the PM channel with the specified user)
.. note:: A User cannot always be specified in certain cases. For example, if using `bot.setTopic`, a User or PM Channel can't be specified as these do not support channel topics.

View File

@@ -16,6 +16,7 @@ Contents:
.. _general-docs:
.. toctree::
:maxdepth: 2
:caption: General
get_started
@@ -25,9 +26,11 @@ Contents:
.. _docs:
.. toctree::
:maxdepth: 2
:caption: Documentation
docs_client
docs_resolvable

View File

@@ -2,4 +2,5 @@
.. _ready : #ready
.. _Server : #server
.. _Channel : #channel
.. _Message : #message
.. _Message : #message
.. _PMChannel : #PMChannel