Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-05 23:47:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs

Browse source
This commit is contained in:
Evennia docbuilder action 2022-10-23 09:04:07 +00:00
parent 478c0b6473
commit 0e0cd24694
958 changed files with 41858 additions and 39649 deletions
Download patch file Download diff file Expand all files Collapse all files

62
docs/1.0-dev/api/evennia.server.profiling.timetrace.html
View file

@ -47,37 +47,8 @@
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.server.profiling.timetrace">
<span id="evennia-server-profiling-timetrace"></span><h1>evennia.server.profiling.timetrace<a class="headerlink" href="#module-evennia.server.profiling.timetrace" title="Permalink to this headline"></a></h1>
<p>Trace a message through the messaging system</p>
<dl class="py function">
<dt id="evennia.server.profiling.timetrace.timetrace">
<code class="sig-prename descclassname">evennia.server.profiling.timetrace.</code><code class="sig-name descname">timetrace</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">message</span></em>, <em class="sig-param"><span class="n">idstring</span></em>, <em class="sig-param"><span class="n">tracemessage</span><span class="o">=</span><span class="default_value">'TEST_MESSAGE'</span></em>, <em class="sig-param"><span class="n">final</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/timetrace.html#timetrace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.timetrace.timetrace" title="Permalink to this definition"></a></dt>
<dd><p>Trace a message with time stamps.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>message</strong> (<em>str</em>) – The actual message coming through</p></li>
<li><p><strong>idstring</strong> (<em>str</em>) – An identifier string specifying where this trace is happening.</p></li>
<li><p><strong>tracemessage</strong> (<em>str</em>) – The start of the message to tag.
This message will get attached time stamp.</p></li>
<li><p><strong>final</strong> (<em>bool</em>) – This is the final leg in the path - include total time in message</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
@ -124,7 +95,36 @@ This message will get attached time stamp.</p></li>
</div>
</div>
<div class="clearer"></div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.server.profiling.timetrace">
<span id="evennia-server-profiling-timetrace"></span><h1>evennia.server.profiling.timetrace<a class="headerlink" href="#module-evennia.server.profiling.timetrace" title="Permalink to this headline"></a></h1>
<p>Trace a message through the messaging system</p>
<dl class="py function">
<dt id="evennia.server.profiling.timetrace.timetrace">
<code class="sig-prename descclassname">evennia.server.profiling.timetrace.</code><code class="sig-name descname">timetrace</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">message</span></em>, <em class="sig-param"><span class="n">idstring</span></em>, <em class="sig-param"><span class="n">tracemessage</span><span class="o">=</span><span class="default_value">'TEST_MESSAGE'</span></em>, <em class="sig-param"><span class="n">final</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/timetrace.html#timetrace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.timetrace.timetrace" title="Permalink to this definition"></a></dt>
<dd><p>Trace a message with time stamps.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>message</strong> (<em>str</em>) – The actual message coming through</p></li>
<li><p><strong>idstring</strong> (<em>str</em>) – An identifier string specifying where this trace is happening.</p></li>
<li><p><strong>tracemessage</strong> (<em>str</em>) – The start of the message to tag.
This message will get attached time stamp.</p></li>
<li><p><strong>final</strong> (<em>bool</em>) – This is the final leg in the path - include total time in message</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
</div>
</div>
</div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>