diff options
| author |  ChrisLovering <[email protected]> | 2022-10-25 20:33:34 +0000 |
|---|---|---|
| committer | ChrisLovering <[email protected]> | 2022-10-25 20:33:34 +0000 |
| commit | 046b81941837518810802061bbb8a7bf91ed5736 (patch) | |
| tree | e5ae76b968e3e4b14dc91cbc42f5bfead51f6bab /v8.2.0/output/botcore.utils.commands.html | |
| parent | Deploying to docs from @ python-discord/bot-core@ac156ecc63e0cd0ea54d58020efe... (diff) | |
Deploying to docs from @ python-discord/bot-core@c7a6ddd00eb371759d837aa75fa397c6d5771401 🚀
Diffstat (limited to 'v8.2.0/output/botcore.utils.commands.html')
| -rw-r--r-- | v8.2.0/output/botcore.utils.commands.html | 42 |
1 files changed, 33 insertions, 9 deletions
diff --git a/v8.2.0/output/botcore.utils.commands.html b/v8.2.0/output/botcore.utils.commands.html index 01eb4a68..2478dc06 100644 --- a/v8.2.0/output/botcore.utils.commands.html +++ b/v8.2.0/output/botcore.utils.commands.html @@ -2,10 +2,10 @@ <html class="no-js" lang="en"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> - <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> + <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="interactions" href="botcore.utils.interactions.html" /><link rel="prev" title="channel" href="botcore.utils.channel.html" /> - <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/> <title>commands - Bot Core v8.2.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -138,7 +138,7 @@ <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> </button> </div> - <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc"> + <label class="toc-overlay-icon toc-header-icon" for="__toc"> <div class="visually-hidden">Toggle table of contents sidebar</div> <i class="icon"><svg><use href="#svg-toc"></use></svg></i> </label> @@ -207,6 +207,10 @@ <a class="version_link reference internal" href="../../main/output/botcore.utils.commands.html">main</a> </li> + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.2.1/output/botcore.utils.commands.html">v8.2.1</a> + </li> + <li class="toctree-l2 current-page"> <a class="version_link reference internal" href="botcore.utils.commands.html">v8.2.0</a> </li> @@ -327,7 +331,7 @@ <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> </button> </div> - <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc"> + <label class="toc-overlay-icon toc-content-icon" for="__toc"> <div class="visually-hidden">Toggle table of contents sidebar</div> <i class="icon"><svg><use href="#svg-toc"></use></svg></i> </label> @@ -340,19 +344,19 @@ <em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">clean_text_or_reply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/15f93e76e4f92817bd10331faca6f531b203b137/botcore/utils/commands.py#L7-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.commands.clean_text_or_reply" title="Permalink to this definition">#</a></dt> <dd><p>Cleans a text argument or replied message’s content.</p> <dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>ctx</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context" title="(in discord.py v2.1.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Context</span></code></a>) – The command’s context</p></li> <li><p><strong>text</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><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.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]) – The provided text argument of the command (if given)</p></li> </ul> </dd> -<dt class="field-even">Raises<span class="colon">:</span></dt> +<dt class="field-even">Raises</dt> <dd class="field-even"><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.BadArgument" title="(in discord.py v2.1.0a)"><strong>discord.ext.commands.BadArgument</strong></a> – <cite>text</cite> wasn’t provided and there’s no reply message / reply message content.</p> </dd> -<dt class="field-odd">Return type<span class="colon">:</span></dt> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></p> </dd> -<dt class="field-even">Returns<span class="colon">:</span></dt> +<dt class="field-even">Returns</dt> <dd class="field-even"><p>The cleaned version of <cite>text</cite>, if given, else replied message.</p> </dd> </dl> @@ -405,8 +409,27 @@ </footer> </div> - <aside class="toc-drawer no-toc"> + <aside class="toc-drawer"> + + <div class="toc-sticky toc-scroll"> + <div class="toc-title-container"> + <span class="toc-title"> + On this page + </span> + </div> + <div class="toc-tree-container"> + <div class="toc-tree"> + <ul> +<li><a class="reference internal" href="#">commands</a><ul> +<li><a class="reference internal" href="#botcore.utils.commands.clean_text_or_reply"><code class="docutils literal notranslate"><span class="pre">clean_text_or_reply()</span></code></a></li> +</ul> +</li> +</ul> + + </div> + </div> + </div> </aside> @@ -416,6 +439,7 @@ <script src="../_static/underscore.js"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="../_static/doctools.js"></script> + <script src="../_static/sphinx_highlight.js"></script> <script src="../_static/scripts/furo.js"></script> <script src="../_static/changelog.js"></script> </body> |