From 372a4059262737bc5c32460fc6981d910408826a Mon Sep 17 00:00:00 2001 From: Quentin Date: Tue, 8 Sep 2020 02:57:39 -0500 Subject: [PATCH] docs(ReactionCollector): Revise JSDoc for ReactionCollector#dispose and #remove (#4709) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Amish Shah Co-authored-by: uhKevinMC Co-authored-by: Sugden <28943913+NotSugden@users.noreply.github.com> Co-authored-by: Antonio Román Co-authored-by: Noel --- src/structures/ReactionCollector.js | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/src/structures/ReactionCollector.js b/src/structures/ReactionCollector.js index a86b4a0c8..e0fa316fc 100644 --- a/src/structures/ReactionCollector.js +++ b/src/structures/ReactionCollector.js @@ -103,7 +103,7 @@ class ReactionCollector extends Collector { */ dispose(reaction, user) { /** - * Emitted whenever a reaction is disposed of and the `dispose` option is set to true. + * Emitted when the reaction had all the users removed and the `dispose` option is set to true. * @event ReactionCollector#dispose * @param {MessageReaction} reaction The reaction that was disposed of * @param {User} user The user that removed the reaction @@ -111,9 +111,7 @@ class ReactionCollector extends Collector { if (reaction.message.id !== this.message.id) return null; /** - * Emitted whenever a reaction is removed from a message and the `dispose` option is set to true. - * Will emit on all reaction removals, as opposed to {@link Collector#dispose} which will only - * be emitted when the entire reaction is removed. + * Emitted when the reaction had one user removed and the `dispose` option is set to true. * @event ReactionCollector#remove * @param {MessageReaction} reaction The reaction that was removed * @param {User} user The user that removed the reaction