Skip to content

Commit

Permalink
make html
Browse files Browse the repository at this point in the history
  • Loading branch information
daniel-rijsketic committed Aug 14, 2024
1 parent cf1202e commit 6efe002
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
Binary file modified unravel/docs/_build/doctrees/unravel/core/utils.doctree
Binary file not shown.
4 changes: 2 additions & 2 deletions unravel/docs/_build/html/_modules/unravel/core/utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -766,12 +766,12 @@ <h1>Source code for unravel.core.utils</h1><div class="highlight"><pre>
<span class="sd"> Parameters:</span>
<span class="sd"> -----------</span>
<span class="sd"> glob_pattern : str</span>
<span class="sd"> The glob pattern to match files (e.g., &#39;*.csv&#39;).</span>
<span class="sd"> The glob pattern to match files.</span>

<span class="sd"> processing_func : function</span>
<span class="sd"> The function to process each file. Should accept a file path as the first argument.</span>

<span class="sd"> *args, **kwargs :</span>
<span class="sd"> ``*args``, ``**kwargs`` :</span>
<span class="sd"> Additional arguments and keyword arguments to pass to the processing function.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">files</span> <span class="o">=</span> <span class="n">glob</span><span class="p">(</span><span class="n">glob_pattern</span><span class="p">)</span>
Expand Down
2 changes: 1 addition & 1 deletion unravel/docs/_build/html/searchindex.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions unravel/docs/_build/html/unravel/core/utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -719,11 +719,11 @@
<section id="parameters">
<h2>Parameters:<a class="headerlink" href="#parameters" title="Link to this heading">#</a></h2>
<dl class="simple">
<dt>glob_pattern<span class="classifier">str</span></dt><dd><p>The glob pattern to match files (e.g., ‘<a href="#id1"><span class="problematic" id="id2">*</span></a>.csv’).</p>
<dt>glob_pattern<span class="classifier">str</span></dt><dd><p>The glob pattern to match files.</p>
</dd>
<dt>processing_func<span class="classifier">function</span></dt><dd><p>The function to process each file. Should accept a file path as the first argument.</p>
</dd>
<dt><a href="#id3"><span class="problematic" id="id4">*</span></a>args, <a href="#id5"><span class="problematic" id="id6">**</span></a>kwargs :</dt><dd><p>Additional arguments and keyword arguments to pass to the processing function.</p>
<dt><code class="docutils literal notranslate"><span class="pre">*args</span></code>, <code class="docutils literal notranslate"><span class="pre">**kwargs</span></code> :</dt><dd><p>Additional arguments and keyword arguments to pass to the processing function.</p>
</dd>
</dl>
</section>
Expand Down

0 comments on commit 6efe002

Please sign in to comment.