Feature: Added Documentation in

This commit is contained in:
2024-03-01 10:44:15 +01:00
parent 2ee2b10c40
commit 16b9105873
51 changed files with 783 additions and 1187 deletions

View File

@@ -286,7 +286,7 @@
</div>
<div class="moduleDocstring">
<div><p class="undocumented">Undocumented</p></div>
<div><p>Common functions that are used all over the package</p></div>
</div>
<div id="splitTables">
@@ -297,7 +297,7 @@
<td>Function</td>
<td><code><a href="#check_bounds" class="internal-link" title="fn_gen.common.check_bounds">check<wbr></wbr>_bounds</a></code></td>
<td><span class="undocumented">Undocumented</span></td>
<td>Checks the whether the given value is within bounds</td>
</tr>
</table>
@@ -328,7 +328,7 @@
</div>
<div class="docstring functionBody">
<div><p class="undocumented">Undocumented</p></div>
<div><p>Checks the whether the given value is within bounds</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Parameters</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">bounds:</span><code><a href="https://docs.python.org/3/library/stdtypes.html#tuple" class="intersphinx-link">tuple</a>[<a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code>, <code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a>]</code></td><td class="fieldArgDesc">The bounds to check within</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">value:</span><code><a href="https://docs.python.org/3/library/functions.html#float" class="intersphinx-link">float</a></code></td><td class="fieldArgDesc">The value to check</td></tr></table></div>
</div>
</div>
</div>
@@ -342,7 +342,7 @@
<div class="container">
<a href="index.html">API Documentation</a> for fn_gen,
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
23.9.1 at 2024-02-06 18:56:15.
23.9.1 at 2024-02-29 14:55:42.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML