docs: Refactor a few @returns descriptions (#6228)

discordjs · Jul 31, 2021 · 82daee5 · 82daee5
1 parent 8b52d06
commit 82daee5
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/src/structures/GuildEmoji.js b/src/structures/GuildEmoji.js
@@ -152,7 +152,7 @@ class GuildEmoji extends BaseGuildEmoji {
   /**
    * Whether this emoji is the same as another one.
    * @param {GuildEmoji|APIEmoji} other The emoji to compare it to
-   * @returns {boolean} Whether the emoji is equal to the given emoji or not
+   * @returns {boolean}
    */
   equals(other) {
     if (other instanceof GuildEmoji) {

diff --git a/src/structures/Sticker.js b/src/structures/Sticker.js
@@ -204,7 +204,7 @@ class Sticker extends Base {
   /**
    * Whether this sticker is the same as another one.
    * @param {Sticker|APISticker} other The sticker to compare it to
-   * @returns {boolean} Whether the sticker is equal to the given sticker or not
+   * @returns {boolean}
    */
   equals(other) {
     if (other instanceof Sticker) {

diff --git a/src/structures/TextChannel.js b/src/structures/TextChannel.js
@@ -162,7 +162,7 @@ class TextChannel extends GuildChannel {
    * Creates a webhook for the channel.
    * @param {string} name The name of the webhook
    * @param {ChannelWebhookCreateOptions} [options] Options for creating the webhook
-   * @returns {Promise<Webhook>} webhook The created webhook
+   * @returns {Promise<Webhook>} Returns the created Webhook
    * @example
    * // Create a webhook for the current channel
    * channel.createWebhook('Snek', {

diff --git a/src/structures/interfaces/TextBasedChannel.js b/src/structures/interfaces/TextBasedChannel.js
@@ -284,7 +284,7 @@ class TextBasedChannel {
    * @param {Collection<Snowflake, Message>|MessageResolvable[]|number} messages
    * Messages or number of messages to delete
    * @param {boolean} [filterOld=false] Filter messages to remove those which are older than two weeks automatically
-   * @returns {Promise<Collection<Snowflake, Message>>} Deleted messages
+   * @returns {Promise<Collection<Snowflake, Message>>} Returns the deleted messages
    * @example
    * // Bulk delete messages
    * channel.bulkDelete(5)