aboutsummaryrefslogtreecommitdiffstats
path: root/v10.0.0/output/pydis_core.html
diff options
context:
space:
mode:
authorGravatar ChrisLovering <[email protected]>2024-03-04 14:53:52 +0000
committerGravatar ChrisLovering <[email protected]>2024-03-04 14:53:52 +0000
commit3eb5ff4e3f0a841d28d8c742eba2e562f9fc2231 (patch)
treecc57ad52e9e9efb2ab82c0bd8596522ace108556 /v10.0.0/output/pydis_core.html
parentDeploying to docs from @ python-discord/bot-core@69eeda8a1914b671af68871dcf55... (diff)
Deploying to docs from @ python-discord/bot-core@c72b515aec03b1d9df49a3d58bfa90a3d864160e 🚀
Diffstat (limited to 'v10.0.0/output/pydis_core.html')
-rw-r--r--v10.0.0/output/pydis_core.html88
1 files changed, 4 insertions, 84 deletions
diff --git a/v10.0.0/output/pydis_core.html b/v10.0.0/output/pydis_core.html
index c855dcd8..a0b54a0c 100644
--- a/v10.0.0/output/pydis_core.html
+++ b/v10.0.0/output/pydis_core.html
@@ -276,86 +276,6 @@
</li>
<li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.3.0-beta/index.html">v8.3.0-beta</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.2.1/index.html">v8.2.1</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.2.0/index.html">v8.2.0</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.1.0/index.html">v8.1.0</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.0.0-beta.4/index.html">v8.0.0-beta.4</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.0.0-beta.3/index.html">v8.0.0-beta.3</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.0.0-beta.2/index.html">v8.0.0-beta.2</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.0.0-beta.1/index.html">v8.0.0-beta.1</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.0.0/index.html">v8.0.0</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.5.0/index.html">v7.5.0</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.4.0-beta1/index.html">v7.4.0-beta1</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.4.0/index.html">v7.4.0</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.3.1/index.html">v7.3.1</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.3.0/index.html">v7.3.0</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.2.2/index.html">v7.2.2</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.2.1/index.html">v7.2.1</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.2.0/index.html">v7.2.0</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.1.3/index.html">v7.1.3</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.1.2/index.html">v7.1.2</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.1.1/index.html">v7.1.1</a>
- </li>
-
- <li class="toctree-l2 ">
<a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.html">v10.7.0</a>
</li>
@@ -464,9 +384,9 @@
<li><p><strong>guild_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – The ID of the guild used for <a class="reference internal" href="#pydis_core.BotBase.wait_until_guild_available" title="pydis_core.BotBase.wait_until_guild_available"><code class="xref py py-func docutils literal notranslate"><span class="pre">wait_until_guild_available()</span></code></a>.</p></li>
<li><p><strong>allowed_roles</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a></span>) – A list of role IDs that the bot is allowed to mention.</p></li>
<li><p><strong>http_session</strong> (<a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientSession" title="(in aiohttp v3.9)"><em>aiohttp.ClientSession</em></a>) – The session to use for the bot.</p></li>
-<li><p><strong>redis_session</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<code class="xref py py-class docutils literal notranslate"><span class="pre">RedisSession</span></code>]</span>) – The <a class="reference external" href="https://github.com/SebastiaanZ/async-rediscache#creating-a-redissession">async_rediscache.RedisSession</a> to use for the bot.</p></li>
-<li><p><strong>api_client</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference internal" href="pydis_core.site_api.html#pydis_core.site_api.APIClient" title="pydis_core.site_api.APIClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">APIClient</span></code></a>]</span>) – The <a class="reference internal" href="pydis_core.site_api.html#pydis_core.site_api.APIClient" title="pydis_core.site_api.APIClient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pydis_core.site_api.APIClient</span></code></a> instance to use for the bot.</p></li>
-<li><p><strong>statsd_url</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]</span>) – The URL of the statsd server to use for the bot. If not given,
+<li><p><strong>redis_session</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">RedisSession</span></code> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The <a class="reference external" href="https://github.com/SebastiaanZ/async-rediscache#creating-a-redissession">async_rediscache.RedisSession</a> to use for the bot.</p></li>
+<li><p><strong>api_client</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="pydis_core.site_api.html#pydis_core.site_api.APIClient" title="pydis_core.site_api.APIClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">APIClient</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The <a class="reference internal" href="pydis_core.site_api.html#pydis_core.site_api.APIClient" title="pydis_core.site_api.APIClient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pydis_core.site_api.APIClient</span></code></a> instance to use for the bot.</p></li>
+<li><p><strong>statsd_url</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The URL of the statsd server to use for the bot. If not given,
a dummy statsd client will be created.</p></li>
</ul>
</dd>
@@ -585,7 +505,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e
To remove them, either remove the entire command or manually edit <cite>bot.all_commands</cite>.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<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-class docutils literal notranslate"><span class="pre">Command</span></code></a>]</span></p>
+<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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-class docutils literal notranslate"><span class="pre">Command</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p>
</dd>
</dl>
</dd></dl>