From 2f52ca50bf86e1c4f0f55147e7af9c85645fef44 Mon Sep 17 00:00:00 2001 From: hydrabolt Date: Sun, 27 Sep 2015 20:02:41 +0100 Subject: [PATCH] MORE DOCUMENTATION KANYE BELIEVE IT --- docs/docs_resolvable.rst | 12 +++++++++++- docs/index.rst | 3 +++ docs/vars.rst | 3 ++- 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/docs_resolvable.rst b/docs/docs_resolvable.rst index cb6e14e71..6fcbc2903 100644 --- a/docs/docs_resolvable.rst +++ b/docs/docs_resolvable.rst @@ -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: \ No newline at end of file +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. \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index d9c10260b..c0e0451a6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 diff --git a/docs/vars.rst b/docs/vars.rst index f99759fb4..2a45df682 100644 --- a/docs/vars.rst +++ b/docs/vars.rst @@ -2,4 +2,5 @@ .. _ready : #ready .. _Server : #server .. _Channel : #channel -.. _Message : #message \ No newline at end of file +.. _Message : #message +.. _PMChannel : #PMChannel \ No newline at end of file