Documentation updated

This commit is contained in:
fjosw 2023-05-03 14:31:55 +00:00
parent 1800790b19
commit ca4f7977fc

View file

@ -1185,7 +1185,7 @@
</span><span id="L-978"><a href="#L-978"><span class="linenos"> 978</span></a>
</span><span id="L-979"><a href="#L-979"><span class="linenos"> 979</span></a><span class="k">def</span> <span class="nf">_format_uncertainty</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">dvalue</span><span class="p">,</span> <span class="n">significance</span><span class="o">=</span><span class="mi">2</span><span class="p">):</span>
</span><span id="L-980"><a href="#L-980"><span class="linenos"> 980</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Creates a string of a value and its error in paranthesis notation, e.g., 13.02(45)&quot;&quot;&quot;</span>
</span><span id="L-981"><a href="#L-981"><span class="linenos"> 981</span></a> <span class="k">if</span> <span class="n">dvalue</span> <span class="o">==</span> <span class="mf">0.0</span><span class="p">:</span>
</span><span id="L-981"><a href="#L-981"><span class="linenos"> 981</span></a> <span class="k">if</span> <span class="n">dvalue</span> <span class="o">==</span> <span class="mf">0.0</span> <span class="ow">or</span> <span class="p">(</span><span class="ow">not</span> <span class="n">np</span><span class="o">.</span><span class="n">isfinite</span><span class="p">(</span><span class="n">dvalue</span><span class="p">)):</span>
</span><span id="L-982"><a href="#L-982"><span class="linenos"> 982</span></a> <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
</span><span id="L-983"><a href="#L-983"><span class="linenos"> 983</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">significance</span><span class="p">,</span> <span class="nb">int</span><span class="p">):</span>
</span><span id="L-984"><a href="#L-984"><span class="linenos"> 984</span></a> <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;significance needs to be an integer.&quot;</span><span class="p">)</span>