Backport documentation fixes (#3683)

* Presence does not extend Base, therefore presence.client was undocumented * Document Client#fetchVoiceRegions returning a promise
discordjs · Jan 13, 2020 · f6d1db6 · f6d1db6
1 parent 5556b05
commit f6d1db6
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/src/client/Client.js b/src/client/Client.js
@@ -349,7 +349,7 @@ class Client extends EventEmitter {
 
   /**
    * Obtains the available voice regions from Discord.
-   * @returns {Collection<string, VoiceRegion>}
+   * @returns {Promise<Collection<string, VoiceRegion>>}
    * @example
    * client.fetchVoiceRegions()
    *   .then(regions => console.log(`Available regions are: ${regions.map(region => region.name).join(', ')}`))

diff --git a/src/structures/Presence.js b/src/structures/Presence.js
@@ -22,6 +22,12 @@ const { ActivityFlags, Endpoints } = require('../util/Constants');
  */
 class Presence {
   constructor(data = {}, client) {
+    /**
+     * The client that instantiated this
+     * @name Presence#client
+     * @type {Client}
+     * @readonly
+     */
     Object.defineProperty(this, 'client', { value: client });
 
     /**