diff --git a/docs/docs_client.rst b/docs/docs_client.rst index 35c929cb7..d4377ad9a 100644 --- a/docs/docs_client.rst +++ b/docs/docs_client.rst @@ -100,4 +100,16 @@ messages An `Array` of Message_ objects the client has received over its uptime. Functions ---------- \ No newline at end of file +--------- + +.. note :: Any functions used here that take callbacks as an optional parameter can also be used as Promises_. For example, you can do: + +.. code-block:: js + + bot.login(email, password).then(success).catch(err); + + // OR use callbacks: + + bot.login(email, password, function(err, token){ + + }); \ No newline at end of file diff --git a/docs/docs_resolvable.rst b/docs/docs_resolvable.rst index 6fcbc2903..b52a358a5 100644 --- a/docs/docs_resolvable.rst +++ b/docs/docs_resolvable.rst @@ -12,7 +12,7 @@ A Channel Resolvable is data that can be resolved to a channel ID. Here is what - A Channel_ object - A Server_ object (the #general channel of the server will be used) -- A String_ representing the channel ID +- 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) diff --git a/docs/vars.rst b/docs/vars.rst index 2a45df682..5aa029c1c 100644 --- a/docs/vars.rst +++ b/docs/vars.rst @@ -3,4 +3,6 @@ .. _Server : #server .. _Channel : #channel .. _Message : #message -.. _PMChannel : #PMChannel \ No newline at end of file +.. _PMChannel : #PMChannel +.. _Channel Resolvable : ./docs_resolvable.html#channel-resolvable +.. _Promises : https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise \ No newline at end of file