From 55447fd4da08ae9e633dca3c4faff5a9b77d440e Mon Sep 17 00:00:00 2001 From: anandre <38661761+anandre@users.noreply.github.com> Date: Wed, 15 May 2019 15:33:27 -0500 Subject: [PATCH] docs(TextChanne): specify unit of rateLimitPerUser (#3272) * Update TextChannel.js Update `setRateLimitPerUser` description to specify the `number` is in seconds, per the Discord docs * Update TextChannel.js Add unit to the rateLimitPerUser property * Update GuildChannel.js --- src/structures/GuildChannel.js | 2 +- src/structures/TextChannel.js | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/structures/GuildChannel.js b/src/structures/GuildChannel.js index 4ba8eb99b..8ffdcfe8f 100644 --- a/src/structures/GuildChannel.js +++ b/src/structures/GuildChannel.js @@ -291,7 +291,7 @@ class GuildChannel extends Channel { * Lock the permissions of the channel to what the parent's permissions are * @property {OverwriteResolvable[]|Collection} [permissionOverwrites] * Permission overwrites for the channel - * @property {number} [rateLimitPerUser] The ratelimit per user for the channel + * @property {number} [rateLimitPerUser] The ratelimit per user for the channel in seconds */ /** diff --git a/src/structures/TextChannel.js b/src/structures/TextChannel.js index 836c55a08..55c3b0d24 100644 --- a/src/structures/TextChannel.js +++ b/src/structures/TextChannel.js @@ -50,7 +50,7 @@ class TextChannel extends GuildChannel { this.lastMessageID = data.last_message_id; /** - * The ratelimit per user for this channel + * The ratelimit per user for this channel in seconds * @type {number} */ this.rateLimitPerUser = data.rate_limit_per_user || 0; @@ -66,7 +66,7 @@ class TextChannel extends GuildChannel { /** * Sets the rate limit per user for this channel. - * @param {number} rateLimitPerUser The new ratelimit + * @param {number} rateLimitPerUser The new ratelimit in seconds * @param {string} [reason] Reason for changing the channel's ratelimits * @returns {Promise} */