deploy: 224bf0f

Author: sbillinge

_modules/diffpy/labpdfproc/tools.html

@@ -96,15 +96,14 @@ <h1>Source code for diffpy.labpdfproc.tools</h1><div class="highlight"><pre>
 <span class="sd">    args argparse.Namespace</span>
 <span class="sd">        the arguments from the parser</span>
 
-<span class="sd">    Returns</span>
-<span class="sd">    -------</span>
-<span class="sd">    pathlib.PosixPath that contains the full path of the output directory</span>
-
 <span class="sd">    it is determined as follows:</span>
 <span class="sd">    If user provides an output directory, use it.</span>
 <span class="sd">    Otherwise, we set it to the current directory if nothing is provided.</span>
 <span class="sd">    We then create the directory if it does not exist.</span>
 
+<span class="sd">    Returns</span>
+<span class="sd">    -------</span>
+<span class="sd">    a Path object that contains the full path of the output directory</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">output_dir</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">output_directory</span><span class="p">)</span><span class="o">.</span><span class="n">resolve</span><span class="p">()</span> <span class="k">if</span> <span class="n">args</span><span class="o">.</span><span class="n">output_directory</span> <span class="k">else</span> <span class="n">Path</span><span class="o">.</span><span class="n">cwd</span><span class="p">()</span><span class="o">.</span><span class="n">resolve</span><span class="p">()</span>
     <span class="n">output_dir</span><span class="o">.</span><span class="n">mkdir</span><span class="p">(</span><span class="n">parents</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">exist_ok</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>

api/diffpy.labpdfproc.html

@@ -275,17 +275,18 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <dd><p>set the output directory based on the given input arguments</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>argparse.Namespace</strong> (<em>args</em>) – the arguments from the parser</p>
-</dd>
-<dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p><ul class="simple">
-<li><p><em>pathlib.PosixPath that contains the full path of the output directory</em></p></li>
-<li><p><em>it is determined as follows</em></p></li>
-<li><p><em>If user provides an output directory, use it.</em></p></li>
-<li><p><em>Otherwise, we set it to the current directory if nothing is provided.</em></p></li>
-<li><p><em>We then create the directory if it does not exist.</em></p></li>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>argparse.Namespace</strong> (<em>args</em>) – the arguments from the parser</p></li>
+<li><p><strong>follows</strong> (<em>it is determined as</em>)</p></li>
+<li><p><strong>directory</strong> (<em>If user provides an output</em>)</p></li>
+<li><p><strong>it.</strong> (<em>use</em>)</p></li>
+<li><p><strong>Otherwise</strong></p></li>
+<li><p><strong>provided.</strong> (<em>we set it to the current directory if nothing is</em>)</p></li>
+<li><p><strong>exist.</strong> (<em>We then create the directory if it does not</em>)</p></li>
 </ul>
-</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>a Path object that contains the full path of the output directory</p>
 </dd>
 </dl>
 </dd></dl>

index.html

@@ -81,7 +81,7 @@ <h1>diffpy.labpdfproc documentation<a class="headerlink" href="#title" title="Li
 <p>diffpy.labpdfproc - Tools for processing x-ray powder diffraction data from laboratory sources.</p>
 <div class="line-block">
 <div class="line">Software version 0.1.1.</div>
-<div class="line">Last updated September 05, 2024.</div>
+<div class="line">Last updated September 06, 2024.</div>
 </div>
 <section id="authors">
 <h2>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h2>