Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-13 10:03:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

MORE DOCUMENTATION KANYE BELIEVE IT

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/docs_resolvable.rst
View File

@@ -1,3 +1,5 @@
.. include:: ./vars.rst
Resolvable Documentation Resolvable Documentation
======================== ========================
@@ -7,3 +9,11 @@ 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.

3
docs/index.rst
View File

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

1
docs/vars.rst
View File

@@ -3,3 +3,4 @@
.. _Server : #server .. _Server : #server
.. _Channel : #channel .. _Channel : #channel
.. _Message : #message .. _Message : #message
.. _PMChannel : #PMChannel