From a044360f2369fbc13a2db0cb1c97f1ac7326e150 Mon Sep 17 00:00:00 2001
From: ChrisLovering
Date: Thu, 18 Aug 2022 15:13:27 +0000
Subject: Deploying to docs from @
python-discord/bot-core@127d0efa219d29e15bd71339d0d2517945aed57c 🚀
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
v7.5.0/output/botcore.async_stats.html | 4 ++++
v7.5.0/output/botcore.exts.html | 4 ++++
v7.5.0/output/botcore.html | 8 ++++++--
v7.5.0/output/botcore.site_api.html | 4 ++++
v7.5.0/output/botcore.utils.caching.html | 4 ++++
v7.5.0/output/botcore.utils.channel.html | 18 +++++++++++-------
v7.5.0/output/botcore.utils.commands.html | 8 ++++++--
v7.5.0/output/botcore.utils.html | 6 +++++-
v7.5.0/output/botcore.utils.interactions.html | 12 ++++++++----
v7.5.0/output/botcore.utils.logging.html | 4 ++++
v7.5.0/output/botcore.utils.members.html | 18 +++++++++++-------
v7.5.0/output/botcore.utils.regex.html | 4 ++++
v7.5.0/output/botcore.utils.scheduling.html | 4 ++++
13 files changed, 75 insertions(+), 23 deletions(-)
(limited to 'v7.5.0/output')
diff --git a/v7.5.0/output/botcore.async_stats.html b/v7.5.0/output/botcore.async_stats.html
index f7e297ff..234b4bcb 100644
--- a/v7.5.0/output/botcore.async_stats.html
+++ b/v7.5.0/output/botcore.async_stats.html
@@ -206,6 +206,10 @@
main
+
+ v8.1.0
+
+
v8.0.0-beta.4
diff --git a/v7.5.0/output/botcore.exts.html b/v7.5.0/output/botcore.exts.html
index 8ab768b9..6b06646f 100644
--- a/v7.5.0/output/botcore.exts.html
+++ b/v7.5.0/output/botcore.exts.html
@@ -206,6 +206,10 @@
main
+
+ v8.1.0
+
+
v8.0.0-beta.4
diff --git a/v7.5.0/output/botcore.html b/v7.5.0/output/botcore.html
index 41af8d9e..85c0458a 100644
--- a/v7.5.0/output/botcore.html
+++ b/v7.5.0/output/botcore.html
@@ -206,6 +206,10 @@
main
+
+ v8.1.0
+
+
v8.0.0-beta.4
@@ -330,7 +334,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.
-
@@ -461,7 +465,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:
-Optional[Command]
+Optional[Command]
diff --git a/v7.5.0/output/botcore.site_api.html b/v7.5.0/output/botcore.site_api.html
index b21a160d..eb9703c3 100644
--- a/v7.5.0/output/botcore.site_api.html
+++ b/v7.5.0/output/botcore.site_api.html
@@ -206,6 +206,10 @@
main
+
+ v8.1.0
+
+
v8.0.0-beta.4
diff --git a/v7.5.0/output/botcore.utils.caching.html b/v7.5.0/output/botcore.utils.caching.html
index 6eed83d2..c4b6369a 100644
--- a/v7.5.0/output/botcore.utils.caching.html
+++ b/v7.5.0/output/botcore.utils.caching.html
@@ -206,6 +206,10 @@
main
+
+ v8.1.0
+
+
v8.0.0-beta.4
diff --git a/v7.5.0/output/botcore.utils.channel.html b/v7.5.0/output/botcore.utils.channel.html
index cd71ad6e..5b67ee2b 100644
--- a/v7.5.0/output/botcore.utils.channel.html
+++ b/v7.5.0/output/botcore.utils.channel.html
@@ -206,6 +206,10 @@
main
+
+ v8.1.0
+
+
v8.0.0-beta.4
@@ -334,20 +338,20 @@
- Parameters:
-
- Raises:
-
- Return type:
-GuildChannel
+GuildChannel
- Returns:
The channel from the ID.
@@ -362,7 +366,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/v7.5.0/output/botcore.utils.commands.html b/v7.5.0/output/botcore.utils.commands.html
index 5568f433..2a577ddf 100644
--- a/v7.5.0/output/botcore.utils.commands.html
+++ b/v7.5.0/output/botcore.utils.commands.html
@@ -206,6 +206,10 @@
main
+
-
+ v8.1.0
+
+
-
v8.0.0-beta.4
@@ -333,12 +337,12 @@
- Parameters:
-ctx (Context) – The command’s context
+ctx (Context) – The command’s context
text (Optional[str]) – 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/v7.5.0/output/botcore.utils.html b/v7.5.0/output/botcore.utils.html
index 0b419116..c688365f 100644
--- a/v7.5.0/output/botcore.utils.html
+++ b/v7.5.0/output/botcore.utils.html
@@ -206,6 +206,10 @@
main
+ -
+ v8.1.0
+
+
-
v8.0.0-beta.4
@@ -332,7 +336,7 @@
apply_monkey_patches()[source]
Applies all common monkey patches for our bots.
-- 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/v7.5.0/output/botcore.utils.interactions.html b/v7.5.0/output/botcore.utils.interactions.html
index 715019b6..1c81a264 100644
--- a/v7.5.0/output/botcore.utils.interactions.html
+++ b/v7.5.0/output/botcore.utils.interactions.html
@@ -206,6 +206,10 @@
main
+
-
+ v8.1.0
+
+
-
v8.0.0-beta.4
@@ -329,7 +333,7 @@
-
class DeleteMessageButton(*, style=<ButtonStyle.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 botcore.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.
@@ -362,7 +366,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:
@@ -371,7 +375,7 @@
allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.
timeout (Optional[float]) – Timeout in seconds from last interaction with the UI before no longer accepting input.
If None then there is no timeout.
-message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with
+
message (Optional[Message]) – 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.
@@ -387,7 +391,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/v7.5.0/output/botcore.utils.logging.html b/v7.5.0/output/botcore.utils.logging.html
index 98391ca1..92c4aa25 100644
--- a/v7.5.0/output/botcore.utils.logging.html
+++ b/v7.5.0/output/botcore.utils.logging.html
@@ -206,6 +206,10 @@
main
+ -
+ v8.1.0
+
+
-
v8.0.0-beta.4
diff --git a/v7.5.0/output/botcore.utils.members.html b/v7.5.0/output/botcore.utils.members.html
index ee095ef1..4deb7cab 100644
--- a/v7.5.0/output/botcore.utils.members.html
+++ b/v7.5.0/output/botcore.utils.members.html
@@ -206,6 +206,10 @@
main
+ -
+ v8.1.0
+
+
-
v8.0.0-beta.4
@@ -326,17 +330,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:
-Optional[Member]
+Optional[Member]
- 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.
@@ -346,13 +350,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/v7.5.0/output/botcore.utils.regex.html b/v7.5.0/output/botcore.utils.regex.html
index 064ea4db..934fa33b 100644
--- a/v7.5.0/output/botcore.utils.regex.html
+++ b/v7.5.0/output/botcore.utils.regex.html
@@ -206,6 +206,10 @@
main
+
-
+ v8.1.0
+
+
-
v8.0.0-beta.4
diff --git a/v7.5.0/output/botcore.utils.scheduling.html b/v7.5.0/output/botcore.utils.scheduling.html
index 7f726b73..21576109 100644
--- a/v7.5.0/output/botcore.utils.scheduling.html
+++ b/v7.5.0/output/botcore.utils.scheduling.html
@@ -206,6 +206,10 @@
main
+ -
+ v8.1.0
+
+
-
v8.0.0-beta.4
--
cgit v1.2.3