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.7.0/.buildinfo | 2 +-
v10.7.0/_static/pygments.css | 12 ++++++------
v10.7.0/changelog.html | 4 ++--
v10.7.0/output/pydis_core.html | 14 +++++++-------
v10.7.0/output/pydis_core.utils.channel.html | 14 +++++++-------
v10.7.0/output/pydis_core.utils.checks.html | 10 +++++-----
v10.7.0/output/pydis_core.utils.commands.html | 4 ++--
v10.7.0/output/pydis_core.utils.cooldown.html | 2 +-
v10.7.0/output/pydis_core.utils.error_handling.html | 4 ++--
v10.7.0/output/pydis_core.utils.html | 2 +-
v10.7.0/output/pydis_core.utils.interactions.html | 10 +++++-----
v10.7.0/output/pydis_core.utils.members.html | 14 +++++++-------
v10.7.0/output/pydis_core.utils.pagination.html | 10 +++++-----
13 files changed, 51 insertions(+), 51 deletions(-)
(limited to 'v10.7.0')
diff --git a/v10.7.0/.buildinfo b/v10.7.0/.buildinfo
index 22a68a86..6772a5e8 100644
--- a/v10.7.0/.buildinfo
+++ b/v10.7.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: 36ed483a88ae18c4a691599371fae5e3
+config: 897dacf3fc437d4d89cc7988b2d15640
tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v10.7.0/_static/pygments.css b/v10.7.0/_static/pygments.css
index c2e07c71..02b4b128 100644
--- a/v10.7.0/_static/pygments.css
+++ b/v10.7.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.7.0/changelog.html b/v10.7.0/changelog.html
index 4244b2ea..b68d22ed 100644
--- a/v10.7.0/changelog.html
+++ b/v10.7.0/changelog.html
@@ -490,14 +490,14 @@
diff --git a/v10.7.0/output/pydis_core.html b/v10.7.0/output/pydis_core.html
index 9dfb507e..e27397e9 100644
--- a/v10.7.0/output/pydis_core.html
+++ b/v10.7.0/output/pydis_core.html
@@ -451,7 +451,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.
-
@@ -596,7 +596,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
@@ -640,7 +640,7 @@ gateway event before giving up and thus not populating the cache for unavailable
-
class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]
-Bases: Paginator
+Bases: Paginator
A class that aids in paginating code blocks for Discord messages.
- Parameters:
@@ -704,15 +704,15 @@ to any user with a moderation role.
pagination_emojis (PaginationEmojis) β The emojis used to navigate pages.
lines (list[str]) β A list of lines to be added to the paginated content.
-ctx (discord.ext.commands.Context) β The context in which the pagination is needed.
-embed (discord.Embed) β The embed that holds the content, it serves as the page.
+ctx (discord.ext.commands.Context) β The context in which the pagination is needed.
+embed (discord.Embed) β The embed that holds the content, it serves as the page.
prefix (str) β The prefix inserted to every page. e.g. three backticks.
suffix (str) β The suffix appended at the end of every page. e.g. three backticks.
max_lines (int) β The maximum amount of lines allowed in a page.
max_size (int) β The maximum amount of codepoints allowed in a page.
scale_to_size (int) β The maximum amount of characters a single line can scale up to.
empty (bool) β Indicates whether an empty line should be added to each provided line.
-restrict_to_user (discord.User) β The user to whom interaction with the pages should be restricted.
+restrict_to_user (discord.User) β The user to whom interaction with the pages should be restricted.
timeout (int) β The timeout after which users cannot change pages anymore.
footer_text (str) β Text to be added as a footer for each page.
url (str) β The url to be set for the pagination embed.
@@ -722,7 +722,7 @@ to any user with a moderation role.
- Return type:
-Message | None
+Message | None
Example:
diff --git a/v10.7.0/output/pydis_core.utils.channel.html b/v10.7.0/output/pydis_core.utils.channel.html
index ab4555df..7bc3bd29 100644
--- a/v10.7.0/output/pydis_core.utils.channel.html
+++ b/v10.7.0/output/pydis_core.utils.channel.html
@@ -455,20 +455,20 @@
- Parameters:
-
- Raises:
-
- Return type:
-GuildChannel | PrivateChannel | Thread
+GuildChannel | PrivateChannel | Thread
- Returns:
The channel from the ID.
@@ -483,7 +483,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.7.0/output/pydis_core.utils.checks.html b/v10.7.0/output/pydis_core.utils.checks.html
index 58d7beed..83526605 100644
--- a/v10.7.0/output/pydis_core.utils.checks.html
+++ b/v10.7.0/output/pydis_core.utils.checks.html
@@ -450,7 +450,7 @@
-
exception ContextCheckFailure(redirect_channel)[source]
-Bases: CheckFailure
+Bases: CheckFailure
Raised when a context-specific check fails.
-
@@ -476,7 +476,7 @@
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.).
+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.
@@ -500,7 +500,7 @@
- Parameters:
-
@@ -521,7 +521,7 @@
- Parameters:
-
@@ -541,7 +541,7 @@
- Parameters:
-ctx (discord.ext.commands.Context) β The context in which the command is being invoked.
+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 ().
diff --git a/v10.7.0/output/pydis_core.utils.commands.html b/v10.7.0/output/pydis_core.utils.commands.html
index d74bb9ef..389371ec 100644
--- a/v10.7.0/output/pydis_core.utils.commands.html
+++ b/v10.7.0/output/pydis_core.utils.commands.html
@@ -454,12 +454,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.7.0/output/pydis_core.utils.cooldown.html b/v10.7.0/output/pydis_core.utils.cooldown.html
index f22ffba0..2e1ac03f 100644
--- a/v10.7.0/output/pydis_core.utils.cooldown.html
+++ b/v10.7.0/output/pydis_core.utils.cooldown.html
@@ -451,7 +451,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.7.0/output/pydis_core.utils.error_handling.html b/v10.7.0/output/pydis_core.utils.error_handling.html
index 4775ce4b..9e293354 100644
--- a/v10.7.0/output/pydis_core.utils.error_handling.html
+++ b/v10.7.0/output/pydis_core.utils.error_handling.html
@@ -454,8 +454,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.7.0/output/pydis_core.utils.html b/v10.7.0/output/pydis_core.utils.html
index aeb10354..e4d1ba63 100644
--- a/v10.7.0/output/pydis_core.utils.html
+++ b/v10.7.0/output/pydis_core.utils.html
@@ -458,7 +458,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.7.0/output/pydis_core.utils.interactions.html b/v10.7.0/output/pydis_core.utils.interactions.html
index f0e0f43e..9da9dd07 100644
--- a/v10.7.0/output/pydis_core.utils.interactions.html
+++ b/v10.7.0/output/pydis_core.utils.interactions.html
@@ -450,7 +450,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.
@@ -483,7 +483,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:
@@ -492,7 +492,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.
@@ -508,7 +508,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
@@ -547,7 +547,7 @@ If None
- Parameters:
-user (User | Member) β The user to check
+user (User | Member) β The user to check
allowed_users (Sequence[int]) β A sequence of user ids that are allowed access
allowed_roles (Sequence[int]) β A sequence of role ids that are allowed access
diff --git a/v10.7.0/output/pydis_core.utils.members.html b/v10.7.0/output/pydis_core.utils.members.html
index 0d9b54f2..59e783c0 100644
--- a/v10.7.0/output/pydis_core.utils.members.html
+++ b/v10.7.0/output/pydis_core.utils.members.html
@@ -447,17 +447,17 @@
members
-Useful helper functions for interactin with discord.Member objects.
+Useful helper functions for interactin with discord.Member objects.
-
async get_or_fetch_member(guild, member_id)[source]
Attempt to get a member from cache; on failure fetch from the API.
- Return type:
-Member | None
+Member | None
- Returns:
-The discord.Member or None to indicate the member could not be found.
+The discord.Member or None to indicate the member could not be found.
@@ -467,13 +467,13 @@
async handle_role_change(member, coro, role)[source]
Await the given coro with role as the sole argument.
Handle errors that we expect to be raised from
-discord.Member.add_roles and discord.Member.remove_roles.
+discord.Member.add_roles and discord.Member.remove_roles.
- Parameters:
-
- Return type:
diff --git a/v10.7.0/output/pydis_core.utils.pagination.html b/v10.7.0/output/pydis_core.utils.pagination.html
index 6c836c12..af469285 100644
--- a/v10.7.0/output/pydis_core.utils.pagination.html
+++ b/v10.7.0/output/pydis_core.utils.pagination.html
@@ -457,7 +457,7 @@
-Bases: Paginator
+Bases: Paginator
A class that aids in paginating code blocks for Discord messages.
- Parameters:
@@ -521,15 +521,15 @@ to any user with a moderation role.
pagination_emojis (PaginationEmojis) β The emojis used to navigate pages.
lines (list[str]) β A list of lines to be added to the paginated content.
-ctx (discord.ext.commands.Context) β The context in which the pagination is needed.
-embed (discord.Embed) β The embed that holds the content, it serves as the page.
+ctx (discord.ext.commands.Context) β The context in which the pagination is needed.
+embed (discord.Embed) β The embed that holds the content, it serves as the page.
prefix (str) β The prefix inserted to every page. e.g. three backticks.
suffix (str) β The suffix appended at the end of every page. e.g. three backticks.
max_lines (int) β The maximum amount of lines allowed in a page.
max_size (int) β The maximum amount of codepoints allowed in a page.
scale_to_size (int) β The maximum amount of characters a single line can scale up to.
empty (bool) β Indicates whether an empty line should be added to each provided line.
-restrict_to_user (discord.User) β The user to whom interaction with the pages should be restricted.
+restrict_to_user (discord.User) β The user to whom interaction with the pages should be restricted.
timeout (int) β The timeout after which users cannot change pages anymore.
footer_text (str) β Text to be added as a footer for each page.
url (str) β The url to be set for the pagination embed.
@@ -539,7 +539,7 @@ to any user with a moderation role.
- Return type:
-Message | None
+Message | None
Example:
--
cgit v1.2.3