Changed create_gap argument to 'window'

numpydoc and black format.

Renamed create_gap to window.

Documentation.

Documentation updates.

Author: Eli

docs/html/_modules/index.html

@@ -157,8 +157,6 @@ <h1>All modules for which code is available</h1>
 <li><a href="vtools/functions/tidalhours.html">vtools.functions.tidalhours</a></li>
 <li><a href="vtools/functions/transition.html">vtools.functions.transition</a></li>
 <li><a href="vtools/functions/unit_conversions.html">vtools.functions.unit_conversions</a></li>
-<li><a href="vtools/functions/unit_conversions_orig.html">vtools.functions.unit_conversions_orig</a></li>
-<li><a href="vtools/functions/viz_gap.html">vtools.functions.viz_gap</a></li>
 </ul>
 
           </div>

docs/html/_modules/vtools/data/timeseries.html

@@ -647,9 +647,12 @@ <h1>Source code for vtools.data.timeseries</h1><div class="highlight"><pre>
 
 <span class="sd">    Parameters:</span>
 <span class="sd">      ts : DataFrame, Series, or xarray object.</span>
-<span class="sd">      raise_exception (bool): If True, raises a ValueError when the index is not regular.</span>
-<span class="sd">                              Otherwise, returns False.</span>
-
+<span class="sd">         Series to evaluate</span>
+<span class="sd">      </span>
+<span class="sd">      raise_exception : bool </span>
+<span class="sd">         If True, raises a ValueError when the index is not regular.</span>
+<span class="sd">         Otherwise, returns False.</span>
+<span class="sd">         </span>
 <span class="sd">    Returns:</span>
 <span class="sd">      bool : True if the time index is regular; False otherwise.</span>
 <span class="sd">    &quot;&quot;&quot;</span>

docs/html/_modules/vtools/functions/envelope.html

@@ -439,7 +439,7 @@ <h1>Source code for vtools.functions.envelope</h1><div class="highlight"><pre>
     <span class="n">passed_right</span> <span class="o">=</span> <span class="p">[]</span>
     <span class="n">kept</span> <span class="o">=</span> <span class="p">[]</span>
 
-    <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">extrema</span><span class="o">.</span><span class="n">iterrows</span><span class="p">():</span>
+    <span class="k">for</span> <span class="n">_</span><span class="p">,</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">extrema</span><span class="o">.</span><span class="n">iterrows</span><span class="p">():</span>
         <span class="n">t</span><span class="p">,</span> <span class="n">v</span> <span class="o">=</span> <span class="n">row</span><span class="p">[</span><span class="s2">&quot;time&quot;</span><span class="p">],</span> <span class="n">row</span><span class="p">[</span><span class="s2">&quot;value&quot;</span><span class="p">]</span>
 
         <span class="n">left</span> <span class="o">=</span> <span class="n">extrema</span><span class="p">[(</span><span class="n">extrema</span><span class="p">[</span><span class="s2">&quot;time&quot;</span><span class="p">]</span> <span class="o">&lt;</span> <span class="n">t</span><span class="p">)</span> <span class="o">&amp;</span> <span class="p">(</span><span class="n">extrema</span><span class="p">[</span><span class="s2">&quot;time&quot;</span><span class="p">]</span> <span class="o">&gt;=</span> <span class="n">t</span> <span class="o">-</span> <span class="n">spacing</span><span class="p">)]</span>

docs/html/_modules/vtools/functions/neighbor_fill.html

@@ -111,21 +111,22 @@ <h1>Source code for vtools.functions.unit_conversions</h1><div class="highlight"
 <span class="sd">Unit conversion helpers.</span>
 
 <span class="sd">This module provides:</span>
-<span class="sd">- linear/affine converters for common engineering units:</span>
-<span class="sd">  metres↔feet, cms↔cfs, °F↔°C (all *functional*, no in-place mutation).</span>
-<span class="sd">- Domain-specific conversions between electrical conductivity (EC, μS/cm)</span>
-<span class="sd">  and practical salinity (PSU) at 25 °C, with optional Hill low-salinity</span>
-<span class="sd">  correction and an accuracy-improving root-finding “refinement” step.</span>
-<span class="sd">- a general-purpose unit conversion function `convert_units()` that uses Pint</span>
-<span class="sd">  by default (with an optional cf_units backend via an environment variable),</span>
-<span class="sd">  and that has fast paths for the above common conversions.</span>
+<span class="sd">  - linear/affine converters for common engineering units:</span>
+<span class="sd">    metres↔feet, cms↔cfs, °F↔°C (all *functional*, no in-place mutation).</span>
+<span class="sd">  - Domain-specific conversions between electrical conductivity (EC, μS/cm)</span>
+<span class="sd">    and practical salinity (PSU) at 25 °C, with optional Hill low-salinity</span>
+<span class="sd">    correction and an accuracy-improving root-finding “refinement” step.</span>
+<span class="sd">  - a general-purpose unit conversion function `convert_units()` that uses Pint</span>
+<span class="sd">    by default (with an optional cf_units backend via an environment variable),</span>
+<span class="sd">    and that has fast paths for the above common conversions.</span>
 
 <span class="sd">Notes</span>
 <span class="sd">-----</span>
-<span class="sd">- PSU is treated here as a practical “unit” for salinity in workflows,</span>
-<span class="sd">  even though in a strict metrological sense it is unitless.</span>
-<span class="sd">- The EC↔PSU conversions assume **25 °C** and no explicit temperature</span>
-<span class="sd">  dependence beyond the optional Hill correction.</span>
+
+<span class="sd">  - PSU is treated here as a practical “unit” for salinity in workflows,</span>
+<span class="sd">    even though in a strict metrological sense it is unitless.</span>
+<span class="sd">  - The EC↔PSU conversions assume **25 °C** and no explicit temperature</span>
+<span class="sd">    dependence beyond the optional Hill correction.</span>
 
 <span class="sd">References</span>
 <span class="sd">----------</span>