diff --git a/docs/docs_client.rst b/docs/docs_client.rst index b6a5ec28e..35c929cb7 100644 --- a/docs/docs_client.rst +++ b/docs/docs_client.rst @@ -1,3 +1,5 @@ +.. include:: ./vars.rst + Client Documentation ==================== @@ -79,11 +81,11 @@ A `Boolean` that is true if the client is ready. A shortcut to checking if ``bot servers ~~~~~~~ -An `Array` of Server_ objects that the client has access to. Represents the servers the client is in. +An `Array` of Server_ objects that the client has access to. channels ~~~~~~~~ -An `Array` of Channel_ objects that the client has access to. Represents the channels the client can access. +An `Array` of Channel_ objects that the client has access to. users ~~~~~ @@ -98,10 +100,4 @@ messages An `Array` of Message_ objects the client has received over its uptime. Functions ---------- - -.. _User : #user -.. _ready : #ready -.. _Server : #server -.. _Channel : #channel -.. _Message : #message \ No newline at end of file +--------- \ No newline at end of file diff --git a/docs/docs_resolvable.rst b/docs/docs_resolvable.rst new file mode 100644 index 000000000..cb6e14e71 --- /dev/null +++ b/docs/docs_resolvable.rst @@ -0,0 +1,9 @@ +Resolvable Documentation +======================== + +To be robust, discord.js needs to handle a wide amount of ambiguous data that is supplied to it. This means you can use functions much more easily. Anything that is resolvable means it can be normalised without you having to do it explicitly. + +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 diff --git a/docs/vars.rst b/docs/vars.rst new file mode 100644 index 000000000..f99759fb4 --- /dev/null +++ b/docs/vars.rst @@ -0,0 +1,5 @@ +.. _User : #user +.. _ready : #ready +.. _Server : #server +.. _Channel : #channel +.. _Message : #message \ No newline at end of file