Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Jun 3, 2024
1 parent d61e27e commit e75ea7d
Show file tree
Hide file tree
Showing 4 changed files with 86 additions and 86 deletions.
16 changes: 8 additions & 8 deletions _modules/acro/acro.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ <h1>Source code for acro.acro</h1><div class="highlight"><pre>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;default&quot;</span><span class="p">,</span> <span class="n">suppress</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Constructs a new ACRO object and reads parameters from config.</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Construct a new ACRO object and reads parameters from config.</span>

<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
Expand Down Expand Up @@ -149,7 +149,7 @@ <h1>Source code for acro.acro</h1><div class="highlight"><pre>
<span class="n">acro_tables</span><span class="o">.</span><span class="n">SURVIVAL_THRESHOLD</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s2">&quot;survival_safe_threshold&quot;</span><span class="p">]</span>

<div class="viewcode-block" id="ACRO.finalise"><a class="viewcode-back" href="../../acro.html#acro.acro.ACRO.finalise">[docs]</a> <span class="k">def</span> <span class="nf">finalise</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;outputs&quot;</span><span class="p">,</span> <span class="n">ext</span><span class="o">=</span><span class="s2">&quot;json&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Records</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Creates a results file for checking.</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Create a results file for checking.</span>

<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
Expand Down Expand Up @@ -184,7 +184,7 @@ <h1>Source code for acro.acro</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">results</span></div>

<div class="viewcode-block" id="ACRO.remove_output"><a class="viewcode-back" href="../../acro.html#acro.acro.ACRO.remove_output">[docs]</a> <span class="k">def</span> <span class="nf">remove_output</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Removes an output from the results.</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Remove an output from the results.</span>

<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
Expand All @@ -194,7 +194,7 @@ <h1>Source code for acro.acro</h1><div class="highlight"><pre>
<span class="bp">self</span><span class="o">.</span><span class="n">results</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">key</span><span class="p">)</span></div>

<div class="viewcode-block" id="ACRO.print_outputs"><a class="viewcode-back" href="../../acro.html#acro.acro.ACRO.print_outputs">[docs]</a> <span class="k">def</span> <span class="nf">print_outputs</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Prints the current results dictionary.</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Print the current results dictionary.</span>

<span class="sd"> Returns</span>
<span class="sd"> -------</span>
Expand All @@ -204,7 +204,7 @@ <h1>Source code for acro.acro</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">results</span><span class="o">.</span><span class="n">print</span><span class="p">()</span></div>

<div class="viewcode-block" id="ACRO.custom_output"><a class="viewcode-back" href="../../acro.html#acro.acro.ACRO.custom_output">[docs]</a> <span class="k">def</span> <span class="nf">custom_output</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">comment</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Adds an unsupported output to the results dictionary.</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Add an unsupported output to the results dictionary.</span>

<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
Expand All @@ -228,7 +228,7 @@ <h1>Source code for acro.acro</h1><div class="highlight"><pre>
<span class="bp">self</span><span class="o">.</span><span class="n">results</span><span class="o">.</span><span class="n">rename</span><span class="p">(</span><span class="n">old</span><span class="p">,</span> <span class="n">new</span><span class="p">)</span></div>

<div class="viewcode-block" id="ACRO.add_comments"><a class="viewcode-back" href="../../acro.html#acro.acro.ACRO.add_comments">[docs]</a> <span class="k">def</span> <span class="nf">add_comments</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">comment</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Adds a comment to an output.</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Add a comment to an output.</span>

<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
Expand All @@ -240,7 +240,7 @@ <h1>Source code for acro.acro</h1><div class="highlight"><pre>
<span class="bp">self</span><span class="o">.</span><span class="n">results</span><span class="o">.</span><span class="n">add_comments</span><span class="p">(</span><span class="n">output</span><span class="p">,</span> <span class="n">comment</span><span class="p">)</span></div>

<div class="viewcode-block" id="ACRO.add_exception"><a class="viewcode-back" href="../../acro.html#acro.acro.ACRO.add_exception">[docs]</a> <span class="k">def</span> <span class="nf">add_exception</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">reason</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Adds an exception request to an output.</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Add an exception request to an output.</span>

<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
Expand All @@ -253,7 +253,7 @@ <h1>Source code for acro.acro</h1><div class="highlight"><pre>


<div class="viewcode-block" id="add_to_acro"><a class="viewcode-back" href="../../acro.html#acro.acro.add_to_acro">[docs]</a><span class="k">def</span> <span class="nf">add_to_acro</span><span class="p">(</span><span class="n">src_path</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">dest_path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;sdc_results&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Adds outputs to an acro object and creates a results file for checking.</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Add outputs to an acro object and creates a results file for checking.</span>

<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
Expand Down
Loading

0 comments on commit e75ea7d

Please sign in to comment.