From 1b15d31b5ae1b1739716fab00b18083c1d7d389a Mon Sep 17 00:00:00 2001
From: anandre <38661761+anandre@users.noreply.github.com>
Date: Fri, 28 Apr 2023 12:19:14 -0500
Subject: [PATCH] docs(AutoModerationRule): update docs (#9464)

* Update AutoModerationRule.js

Update the docs descriptions for some of the AutoModerationRule methods to make them clearer and easier to understand

* Update AutoModerationRule.js

Updated the `exemptRoles` and `exemptChannels` parameter descriptions for their respective helper methods to match the typedef `AutoModerationRuleEditOptions`.

* Update AutoModerationRule.js

Update the `mentionTotalLimit` description to match the one in the `AutoModerationTriggerMetadataOptions` typdef.

* Update packages/discord.js/src/structures/AutoModerationRule.js

Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com>

---------

Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
---
 .../discord.js/src/structures/AutoModerationRule.js    | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/packages/discord.js/src/structures/AutoModerationRule.js b/packages/discord.js/src/structures/AutoModerationRule.js
index 3fcbda2b7..860982e12 100644
--- a/packages/discord.js/src/structures/AutoModerationRule.js
+++ b/packages/discord.js/src/structures/AutoModerationRule.js
@@ -206,7 +206,8 @@ class AutoModerationRule extends Base {
 
   /**
    * Sets the allow list for this auto moderation rule.
-   * @param {string[]} allowList The allow list of this auto moderation rule
+   * @param {string[]} allowList The substrings that will be exempt from triggering
+   * {@link AutoModerationRuleTriggerType.Keyword} and {@link AutoModerationRuleTriggerType.KeywordPreset}
    * @param {string} [reason] The reason for changing the allow list of this auto moderation rule
    * @returns {Promise<AutoModerationRule>}
    */
@@ -216,7 +217,7 @@ class AutoModerationRule extends Base {
 
   /**
    * Sets the mention total limit for this auto moderation rule.
-   * @param {number} mentionTotalLimit The mention total limit of this auto moderation rule
+   * @param {number} mentionTotalLimit The total number of unique role and user mentions allowed per message
    * @param {string} [reason] The reason for changing the mention total limit of this auto moderation rule
    * @returns {Promise<AutoModerationRule>}
    */
@@ -246,7 +247,8 @@ class AutoModerationRule extends Base {
 
   /**
    * Sets the exempt roles for this auto moderation rule.
-   * @param {Collection<Snowflake, Role>|RoleResolvable[]} [exemptRoles] The exempt roles of this auto moderation rule
+   * @param {Collection<Snowflake, Role>|RoleResolvable[]} [exemptRoles]
+   * The roles that should not be affected by the auto moderation rule
    * @param {string} [reason] The reason for changing the exempt roles of this auto moderation rule
    * @returns {Promise<AutoModerationRule>}
    */
@@ -257,7 +259,7 @@ class AutoModerationRule extends Base {
   /**
    * Sets the exempt channels for this auto moderation rule.
    * @param {Collection<Snowflake, GuildChannel|ThreadChannel>|GuildChannelResolvable[]} [exemptChannels]
-   * The exempt channels of this auto moderation rule
+   * The channels that should not be affected by the auto moderation rule
    * @param {string} [reason] The reason for changing the exempt channels of this auto moderation rule
    * @returns {Promise<AutoModerationRule>}
    */