diff options
| author | 2024-06-22 11:10:12 +0000 | |
|---|---|---|
| committer | 2024-06-22 11:10:12 +0000 | |
| commit | 03157db62f6bfad9862564a9d230de707254b57b (patch) | |
| tree | 8572080ce769640ca022240acb38f140425270b7 /main/output/pydis_core.utils.html | |
| parent | Deploying to docs from @ python-discord/bot-core@5873ad7d9fc5a4fa803b1411db18... (diff) | |
Deploying to docs from @ python-discord/bot-core@3fe3eaefc11cd8e5c2ca17fe9e99fe3ef5639933 🚀
Diffstat (limited to 'main/output/pydis_core.utils.html')
| -rw-r--r-- | main/output/pydis_core.utils.html | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/main/output/pydis_core.utils.html b/main/output/pydis_core.utils.html index f8b57199..578be712 100644 --- a/main/output/pydis_core.utils.html +++ b/main/output/pydis_core.utils.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="error_handling package" href="pydis_core.utils.error_handling.html" /><link rel="prev" title="Exts" href="pydis_core.exts.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.3.7 and Furo 2024.05.06 --> - <title>Utils - Pydis Core Latest (11.1.0)</title> + <title>Utils - Pydis Core Latest (11.2.0)</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=387cc868" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -183,7 +183,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.1.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.2.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -210,7 +210,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.1.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.2.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -457,7 +457,7 @@ <p>Useful utilities and tools for Discord bot development.</p> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.apply_monkey_patches"> -<span class="sig-name descname"><span class="pre">apply_monkey_patches</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/5873ad7d9fc5a4fa803b1411db1804c5998aaab5/pydis_core/utils/__init__.py#L28-L42"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.apply_monkey_patches" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">apply_monkey_patches</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/3fe3eaefc11cd8e5c2ca17fe9e99fe3ef5639933/pydis_core/utils/__init__.py#L28-L42"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.apply_monkey_patches" title="Link to this definition">¶</a></dt> <dd><p>Applies all common monkey patches for our bots.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -465,7 +465,7 @@ </dd> </dl> <dl> -<dt>Patches <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.4.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Command</span></code></a> and <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Group" title="(in discord.py v2.4.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Group</span></code></a> to support root aliases.</dt><dd><p>A <code class="docutils literal notranslate"><span class="pre">root_aliases</span></code> keyword argument is added to these two objects, which is a sequence of alias names +<dt>Patches <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Command</span></code></a> and <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Group" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Group</span></code></a> to support root aliases.</dt><dd><p>A <code class="docutils literal notranslate"><span class="pre">root_aliases</span></code> 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.</p> <p>It’s stored as an attribute also named <code class="docutils literal notranslate"><span class="pre">root_aliases</span></code></p> </dd> @@ -476,7 +476,7 @@ that will act as top-level groups rather than being aliases of the command’s g <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.unqualify"> -<span class="sig-name descname"><span class="pre">unqualify</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/5873ad7d9fc5a4fa803b1411db1804c5998aaab5/pydis_core/utils/_extensions.py#L10-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.unqualify" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">unqualify</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/3fe3eaefc11cd8e5c2ca17fe9e99fe3ef5639933/pydis_core/utils/_extensions.py#L10-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.unqualify" title="Link to this definition">¶</a></dt> <dd><p>Return an unqualified name given a qualified module/package <code class="docutils literal notranslate"><span class="pre">name</span></code>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -749,7 +749,7 @@ that will act as top-level groups rather than being aliases of the command’s g </aside> </div> -</div><script src="../_static/documentation_options.js?v=bffcfdfb"></script> +</div><script src="../_static/documentation_options.js?v=2d832310"></script> <script src="../_static/doctools.js?v=9a2dae69"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=4e2eecee"></script> |