From cf16350107a4ffd6a48d258a47fffc0733c138b2 Mon Sep 17 00:00:00 2001 From: jb3 Date: Fri, 17 Oct 2025 18:04:11 +0000 Subject: Deploying to docs from @ python-discord/bot-core@9f0162c0869ee8e0ae158636c8f0eac96159a675 πŸš€ MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- v10.6.0/output/pydis_core.utils.checks.html | 40 ++++++++++++++--------------- 1 file changed, 20 insertions(+), 20 deletions(-) (limited to 'v10.6.0/output/pydis_core.utils.checks.html') diff --git a/v10.6.0/output/pydis_core.utils.checks.html b/v10.6.0/output/pydis_core.utils.checks.html index a021ed7f..f3c74565 100644 --- a/v10.6.0/output/pydis_core.utils.checks.html +++ b/v10.6.0/output/pydis_core.utils.checks.html @@ -10,8 +10,8 @@ - + @@ -472,7 +472,7 @@
exception ContextCheckFailure(redirect_channel)[source]ΒΆ
-

Bases: CheckFailure

+

Bases: CheckFailure

Raised when a context-specific check fails.

@@ -496,10 +496,10 @@
Parameters:
    -
  • rate (int) – Number of times a command can be used before triggering a cooldown.

  • -
  • per (float) – The duration (in seconds) for how long the cooldown lasts.

  • -
  • type (discord.ext.commands.BucketType) – The type of cooldown (per user, per channel, per guild, etc.).

  • -
  • bypass_roles (Iterable[int]) – An iterable of role IDs that bypass the cooldown.

  • +
  • rate (int) – Number of times a command can be used before triggering a cooldown.

  • +
  • per (float) – The duration (in seconds) for how long the cooldown lasts.

  • +
  • type (discord.ext.commands.BucketType) – The type of cooldown (per user, per channel, per guild, etc.).

  • +
  • bypass_roles (Iterable[int]) – An iterable of role IDs that bypass the cooldown.

Returns:
@@ -509,7 +509,7 @@

Callable

Raises:
-

TypeError – If the decorator is not applied to an instance of Command.

+

TypeError – If the decorator is not applied to an instance of Command.

@@ -522,15 +522,15 @@
Parameters:
Returns:

True if the context’s author has at least one of the specified roles; False otherwise.

Return type:
-

bool

+

bool

@@ -543,15 +543,15 @@
Parameters:
Returns:

True if the context’s author doesn’t have any of the specified roles; False otherwise.

Return type:
-

bool

+

bool

@@ -563,19 +563,19 @@
Parameters:
    -
  • ctx (discord.ext.commands.Context) – The context in which the command is being invoked.

  • -
  • redirect (int | None) – The channel ID to redirect the user to, if any.

  • -
  • channels (Container[int]) – Whitelisted channel IDs. Defaults to ().

  • -
  • categories (Container[int]) – Whitelisted category IDs. Defaults to ().

  • -
  • roles (Container[int]) – Whitelisted role IDs. Defaults to ().

  • -
  • fail_silently (bool) – Whether to fail silently without raising an exception. Defaults to False.

  • +
  • ctx (discord.ext.commands.Context) – The context in which the command is being invoked.

  • +
  • redirect (int | None) – The channel ID to redirect the user to, if any.

  • +
  • channels (Container[int]) – Whitelisted channel IDs. Defaults to ().

  • +
  • categories (Container[int]) – Whitelisted category IDs. Defaults to ().

  • +
  • roles (Container[int]) – Whitelisted role IDs. Defaults to ().

  • +
  • fail_silently (bool) – Whether to fail silently without raising an exception. Defaults to False.

Returns:

True if the command is used in a whitelisted context; False otherwise.

Return type:
-

bool

+

bool

Raises:

InWhitelistCheckFailure – If the context is not whitelisted and fail_silently is False.

-- cgit v1.2.3