From 3da95d7e68f02f101de722af33cc1ddaf54c65da Mon Sep 17 00:00:00 2001
From: SpaceEEC <SpaceEEC@users.noreply.github.com>
Date: Tue, 4 Jul 2017 00:22:48 +0200
Subject: [PATCH] Corrected some docstrings (#1611)

* corrected some docstrings

* merge master

* fixed MessageSearchResult typedef and moved the note for the hit property to there
---
 src/structures/Guild.js                       | 6 ++----
 src/structures/interfaces/TextBasedChannel.js | 2 --
 src/structures/shared/Search.js               | 5 +++--
 3 files changed, 5 insertions(+), 8 deletions(-)

diff --git a/src/structures/Guild.js b/src/structures/Guild.js
index 7732b77eb..5be248bdd 100644
--- a/src/structures/Guild.js
+++ b/src/structures/Guild.js
@@ -406,7 +406,7 @@ class Guild {
 
   /**
    * Fetch all webhooks for the guild.
-   * @returns {Collection<Snowflake, Webhook>}
+   * @returns {Promise<Collection<Snowflake, Webhook>>}
    */
   fetchWebhooks() {
     return this.client.api.guilds[this.id].webhooks.get().then(data => {
@@ -418,7 +418,7 @@ class Guild {
 
   /**
    * Fetch available voice regions.
-   * @returns {Collection<string, VoiceRegion>}
+   * @returns {Promise<Collection<string, VoiceRegion>>}
    */
   fetchVoiceRegions() {
     return this.client.api.guilds[this.id].regions.get().then(res => {
@@ -539,8 +539,6 @@ class Guild {
    * <warn>This is only available when using a user account.</warn>
    * @param {MessageSearchOptions} [options={}] Options to pass to the search
    * @returns {Promise<MessageSearchResult>}
-   * An array containing arrays of messages. Each inner array is a search context cluster.
-   * The message which has triggered the result will have the `hit` property set to `true`.
    * @example
    * guild.search({
    *   content: 'discord.js',
diff --git a/src/structures/interfaces/TextBasedChannel.js b/src/structures/interfaces/TextBasedChannel.js
index 3cc4d3d7e..f47db7d1c 100644
--- a/src/structures/interfaces/TextBasedChannel.js
+++ b/src/structures/interfaces/TextBasedChannel.js
@@ -203,8 +203,6 @@ class TextBasedChannel {
    * <warn>This is only available when using a user account.</warn>
    * @param {MessageSearchOptions} [options={}] Options to pass to the search
    * @returns {Promise<MessageSearchResult>}
-   * An array containing arrays of messages. Each inner array is a search context cluster
-   * The message which has triggered the result will have the `hit` property set to `true`
    * @example
    * channel.search({
    *   content: 'discord.js',
diff --git a/src/structures/shared/Search.js b/src/structures/shared/Search.js
index 76ed72eef..6d7e510b8 100644
--- a/src/structures/shared/Search.js
+++ b/src/structures/shared/Search.js
@@ -31,8 +31,9 @@ const { TypeError } = require('../../errors');
 
 /**
  * @typedef {Object} MessageSearchResult
- * @type {number} total Total result count
- * @type {Array<Message[]>} results Array of message results
+ * @property {number} total Total result count
+ * @property {Array<Message[]>} results Array of message results
+ * The message which has triggered the result will have the `hit` property set to `true`
  */
 
 module.exports = function search(target, options) {