aboutsummaryrefslogtreecommitdiffstats
path: root/v7.1.2/output/botcore.utils.logging.html
diff options
context:
space:
mode:
authorGravatar ChrisLovering <[email protected]>2022-06-28 12:03:01 +0000
committerGravatar ChrisLovering <[email protected]>2022-06-28 12:03:01 +0000
commit49384c7aab72ead973462e535fcbabb488af0a5f (patch)
treeaaa74d740539c85e40218a957152bbd470423bea /v7.1.2/output/botcore.utils.logging.html
parentDeploying to docs from @ python-discord/bot-core@109da8bdde367e85d334b8f96dfa... (diff)
Deploying to docs from @ python-discord/bot-core@149e278d3b6111a6f45f31e993114b38745bb545 🚀
Diffstat (limited to 'v7.1.2/output/botcore.utils.logging.html')
-rw-r--r--v7.1.2/output/botcore.utils.logging.html16
1 files changed, 10 insertions, 6 deletions
diff --git a/v7.1.2/output/botcore.utils.logging.html b/v7.1.2/output/botcore.utils.logging.html
index ad9a8a54..3f48ae5f 100644
--- a/v7.1.2/output/botcore.utils.logging.html
+++ b/v7.1.2/output/botcore.utils.logging.html
@@ -2,7 +2,7 @@
<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.17.1: http://docutils.sourceforge.net/" />
+ <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.18.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="members" href="botcore.utils.members.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.0.2, furo 2022.06.21"/>
@@ -205,6 +205,10 @@
</li>
<li class="toctree-l2 ">
+ <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.logging.html">v7.2.0-alpha</a>
+ </li>
+
+ <li class="toctree-l2 ">
<a class="version_link reference internal" href="../../v7.1.3/output/botcore.utils.logging.html">v7.1.3</a>
</li>
@@ -287,14 +291,14 @@
</pre></div>
</div>
<dl class="field-list simple">
-<dt class="field-odd">Parameters</dt>
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>msg</strong> (<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 message to be logged.</p></li>
<li><p><strong>args</strong> – Passed to the base log function as is.</p></li>
<li><p><strong>kwargs</strong> – Passed to the base log function as is.</p></li>
</ul>
</dd>
-<dt class="field-even">Return type</dt>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p>
</dd>
</dl>
@@ -307,13 +311,13 @@
<span class="sig-name descname"><span class="pre">get_logger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</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/88373772f264ee359d60072aea1578cbf50ff4ff/botcore/utils/logging.py#L35-L46"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.get_logger" title="Permalink to this definition">#</a></dt>
<dd><p>Utility to make mypy recognise that logger is of type <a class="reference internal" href="#botcore.utils.logging.CustomLogger" title="botcore.utils.logging.CustomLogger"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CustomLogger</span></code></a>.</p>
<dl class="field-list simple">
-<dt class="field-odd">Parameters</dt>
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>name</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 name given to the logger.</p>
</dd>
-<dt class="field-even">Return type</dt>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#botcore.utils.logging.CustomLogger" title="botcore.utils.logging.CustomLogger"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomLogger</span></code></a></p>
</dd>
-<dt class="field-odd">Returns</dt>
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>An instance of the <a class="reference internal" href="#botcore.utils.logging.CustomLogger" title="botcore.utils.logging.CustomLogger"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CustomLogger</span></code></a> class.</p>
</dd>
</dl>