From 77d42373a119284a7bfaa98575f6d93949521364 Mon Sep 17 00:00:00 2001 From: anandre <38661761+anandre@users.noreply.github.com> Date: Sat, 12 Dec 2020 07:50:04 -0600 Subject: [PATCH] docs: permission overwrite methods descriptions (#5079) * Change permission overwrite methods descriptions The methods `GuildChannel#updateOverwrite` and `#createOverwrite` had some awkward wording in the description: `. (...)` does not look good. This PR cleans up the descriptions to be one sentence that's clearer in meaning. There's also changes to make `permission overwrite/s` consistent - some lines had `permissions overwrite/s`. * Update src/structures/GuildChannel.js Co-authored-by: SpaceEEC * Update src/structures/GuildChannel.js Co-authored-by: Sugden <28943913+NotSugden@users.noreply.github.com> * Update src/structures/GuildChannel.js Co-authored-by: Sugden <28943913+NotSugden@users.noreply.github.com> Co-authored-by: SpaceEEC Co-authored-by: Sugden <28943913+NotSugden@users.noreply.github.com> --- src/structures/GuildChannel.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/structures/GuildChannel.js b/src/structures/GuildChannel.js index f397c3c32..3dfa0839d 100644 --- a/src/structures/GuildChannel.js +++ b/src/structures/GuildChannel.js @@ -213,7 +213,7 @@ class GuildChannel extends Channel { } /** - * Updates Overwrites for a user or role in this channel. (creates if non-existent) + * Updates permission overwrites for a user or role in this channel, or creates an entry if not already present. * @param {RoleResolvable|UserResolvable} userOrRole The user or role to update * @param {PermissionOverwriteOptions} options The options for the update * @param {string} [reason] Reason for creating/editing this overwrite @@ -236,13 +236,13 @@ class GuildChannel extends Channel { } /** - * Overwrites the permissions for a user or role in this channel. (replaces if existent) + * Creates permission overwrites for a user or role in this channel, or replaces them if already present. * @param {RoleResolvable|UserResolvable} userOrRole The user or role to update * @param {PermissionOverwriteOptions} options The options for the update * @param {string} [reason] Reason for creating/editing this overwrite * @returns {Promise} * @example - * // Create or Replace permissions overwrites for a message author + * // Create or Replace permission overwrites for a message author * message.channel.createOverwrite(message.author, { * SEND_MESSAGES: false * })