From 03157db62f6bfad9862564a9d230de707254b57b Mon Sep 17 00:00:00 2001
From: ChrisLovering
Date: Sat, 22 Jun 2024 11:10:12 +0000
Subject: Deploying to docs from @
python-discord/bot-core@3fe3eaefc11cd8e5c2ca17fe9e99fe3ef5639933 🚀
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
v10.1.0/.buildinfo | 2 +-
v10.1.0/_static/pygments.css | 12 ++++++------
v10.1.0/changelog.html | 4 ++--
v10.1.0/output/pydis_core.html | 4 ++--
v10.1.0/output/pydis_core.utils.channel.html | 14 +++++++-------
v10.1.0/output/pydis_core.utils.commands.html | 4 ++--
v10.1.0/output/pydis_core.utils.cooldown.html | 2 +-
v10.1.0/output/pydis_core.utils.error_handling.html | 4 ++--
v10.1.0/output/pydis_core.utils.html | 2 +-
v10.1.0/output/pydis_core.utils.interactions.html | 8 ++++----
v10.1.0/output/pydis_core.utils.members.html | 14 +++++++-------
11 files changed, 35 insertions(+), 35 deletions(-)
(limited to 'v10.1.0')
diff --git a/v10.1.0/.buildinfo b/v10.1.0/.buildinfo
index d34b153a..629beeef 100644
--- a/v10.1.0/.buildinfo
+++ b/v10.1.0/.buildinfo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: a0d98a8e3f8ea3d440d75b150af86912
+config: 35665a1bb343262893b36ff1e80214f6
tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v10.1.0/_static/pygments.css b/v10.1.0/_static/pygments.css
index c2e07c71..02b4b128 100644
--- a/v10.1.0/_static/pygments.css
+++ b/v10.1.0/_static/pygments.css
@@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /*
body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */
body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */
body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */
-body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */
+body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */
body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */
body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */
-body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */
+body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */
body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */
body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */
body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */
body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */
body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */
body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */
-body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */
+body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */
body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */
body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */
body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */
@@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol
body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */
body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */
body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */
-body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */
+body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */
body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */
body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */
-body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */
+body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */
body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */
body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */
body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */
body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */
body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */
body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */
-body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */
+body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */
body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */
body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */
body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */
diff --git a/v10.1.0/changelog.html b/v10.1.0/changelog.html
index 40d9a77f..334b51d9 100644
--- a/v10.1.0/changelog.html
+++ b/v10.1.0/changelog.html
@@ -445,14 +445,14 @@
Changelog
diff --git a/v10.1.0/output/pydis_core.html b/v10.1.0/output/pydis_core.html
index 5abe2931..c3ee527a 100644
--- a/v10.1.0/output/pydis_core.html
+++ b/v10.1.0/output/pydis_core.html
@@ -447,7 +447,7 @@
-
class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]
-Bases: Bot
+Bases: Bot
A sub-class that implements many common features that Python Discord bots use.
-
@@ -592,7 +592,7 @@ will not be set and guild_available_but_cache_empty event will be e
To remove them, either remove the entire command or manually edit bot.all_commands.
- Return type:
-Command
| None
+Command
| None
diff --git a/v10.1.0/output/pydis_core.utils.channel.html b/v10.1.0/output/pydis_core.utils.channel.html
index 8bc44ab8..adda7a3d 100644
--- a/v10.1.0/output/pydis_core.utils.channel.html
+++ b/v10.1.0/output/pydis_core.utils.channel.html
@@ -451,20 +451,20 @@
- Parameters:
-
- Raises:
-
- Return type:
-GuildChannel
| PrivateChannel
| Thread
+GuildChannel
| PrivateChannel
| Thread
- Returns:
The channel from the ID.
@@ -479,7 +479,7 @@
- Parameters:
-channel (TextChannel
) – The channel to check.
+channel (TextChannel
) – The channel to check.
category_id (int
) – The category to check for.
diff --git a/v10.1.0/output/pydis_core.utils.commands.html b/v10.1.0/output/pydis_core.utils.commands.html
index c6e0e39e..c763d5af 100644
--- a/v10.1.0/output/pydis_core.utils.commands.html
+++ b/v10.1.0/output/pydis_core.utils.commands.html
@@ -450,12 +450,12 @@
- Parameters:
-ctx (Context
) – The command’s context
+ctx (Context
) – The command’s context
text (str
| None
) – The provided text argument of the command (if given)
- Raises:
-discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.
+discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.
- Return type:
str
diff --git a/v10.1.0/output/pydis_core.utils.cooldown.html b/v10.1.0/output/pydis_core.utils.cooldown.html
index 809205e3..a7954878 100644
--- a/v10.1.0/output/pydis_core.utils.cooldown.html
+++ b/v10.1.0/output/pydis_core.utils.cooldown.html
@@ -447,7 +447,7 @@
-
exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]
-Bases: CommandError
, Generic
[P
, R
]
+Bases: CommandError
, Generic
[P
, R
]
Raised when a command is invoked while on cooldown.
-
diff --git a/v10.1.0/output/pydis_core.utils.error_handling.html b/v10.1.0/output/pydis_core.utils.error_handling.html
index f73bf3b5..afc305dd 100644
--- a/v10.1.0/output/pydis_core.utils.error_handling.html
+++ b/v10.1.0/output/pydis_core.utils.error_handling.html
@@ -450,8 +450,8 @@
- Parameters:
-error (Forbidden
) – The raised discord.Forbidden
to check.
-message (Message
| None
) – The message to reply to and include in logs, if error is 90001 and message is provided.
+error (Forbidden
) – The raised discord.Forbidden
to check.
+message (Message
| None
) – The message to reply to and include in logs, if error is 90001 and message is provided.
- Return type:
diff --git a/v10.1.0/output/pydis_core.utils.html b/v10.1.0/output/pydis_core.utils.html
index 6f37fcbd..27aa7938 100644
--- a/v10.1.0/output/pydis_core.utils.html
+++ b/v10.1.0/output/pydis_core.utils.html
@@ -454,7 +454,7 @@
-- Patches
discord.ext.commands.Command
and discord.ext.commands.Group
to support root aliases. A root_aliases
keyword argument is added to these two objects, which is a sequence of alias names
+
- Patches
discord.ext.commands.Command
and discord.ext.commands.Group
to support root aliases. A root_aliases
keyword argument is added to these two objects, which is a sequence of alias names
that will act as top-level groups rather than being aliases of the command’s group.
It’s stored as an attribute also named root_aliases
diff --git a/v10.1.0/output/pydis_core.utils.interactions.html b/v10.1.0/output/pydis_core.utils.interactions.html
index 4bf512a4..36542bc6 100644
--- a/v10.1.0/output/pydis_core.utils.interactions.html
+++ b/v10.1.0/output/pydis_core.utils.interactions.html
@@ -446,7 +446,7 @@
-
class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]
-Bases: Button
+Bases: Button
A button that can be added to a view to delete the message containing the view on click.
This button itself carries out no interaction checks, these should be done by the parent view.
See pydis_core.utils.interactions.ViewWithUserAndRoleCheck
for a view that implements basic checks.
@@ -479,7 +479,7 @@
-
class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]
-Bases: View
+Bases: View
A view that allows the original invoker and moderators to interact with it.
- Parameters:
@@ -488,7 +488,7 @@
allowed_roles (Sequence
[int
]) – A sequence of role ids that are allowed to interact with the view.
timeout (float
| None
) – Timeout in seconds from last interaction with the UI before no longer accepting input.
If None
then there is no timeout.
-message (Message
| None
) – The message to remove the view from on timeout. This can also be set with
+
message (Message
| None
) – The message to remove the view from on timeout. This can also be set with
view.message = await ctx.send( ... )`
, or similar, after the view is instantiated.
@@ -504,7 +504,7 @@ If NoneEnsure the user clicking the button is the view invoker, or a moderator.
- Parameters:
-interaction (Interaction
) – The interaction that occurred.
+interaction (Interaction
) – The interaction that occurred.
- Return type:
bool
diff --git a/v10.1.0/output/pydis_core.utils.members.html b/v10.1.0/output/pydis_core.utils.members.html
index 80c65867..c1b434f0 100644
--- a/v10.1.0/output/pydis_core.utils.members.html
+++ b/v10.1.0/output/pydis_core.utils.members.html
@@ -443,17 +443,17 @@