deploy: 80df351

_modules/lkj/strings.html

@@ -108,17 +108,27 @@ <h1>Source code for lkj.strings</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="most_common_indent">
 <a class="viewcode-back" href="../../module_docs/lkj/strings.html#lkj.strings.most_common_indent">[docs]</a>
-<span class="k">def</span> <span class="nf">most_common_indent</span><span class="p">(</span><span class="n">string</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
+<span class="k">def</span> <span class="nf">most_common_indent</span><span class="p">(</span><span class="n">string</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">ignore_first_line</span><span class="o">=</span><span class="kc">False</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="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Find the most common indentation in a string.</span>
 
 <span class="sd">    :param string: The string to analyze.</span>
+<span class="sd">    :param ignore_first_line: Whether to ignore the first line when determining the</span>
+<span class="sd">        indentation. Default is False. One case where you want True is when using python</span>
+<span class="sd">        triple quotes (as in docstrings, for example), since the first line often has</span>
+<span class="sd">        no indentation (from the point of view of the string, in this case.</span>
 <span class="sd">    :return: The most common indentation string.</span>
 
+<span class="sd">    Examples:</span>
+
 <span class="sd">    &gt;&gt;&gt; most_common_indent(&#39;    This is a test.\n    Another line.&#39;)</span>
 <span class="sd">    &#39;    &#39;</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">indents</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;^( *)\S&quot;</span><span class="p">,</span> <span class="n">string</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">MULTILINE</span><span class="p">)</span>
+    <span class="n">n_lines</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">indents</span><span class="p">)</span>
+    <span class="k">if</span> <span class="n">ignore_first_line</span> <span class="ow">and</span> <span class="n">n_lines</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
+        <span class="c1"># if there&#39;s more than one line, ignore the indent of the first</span>
+        <span class="n">indents</span> <span class="o">=</span> <span class="n">indents</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
     <span class="k">return</span> <span class="nb">max</span><span class="p">(</span><span class="n">indents</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="n">indents</span><span class="o">.</span><span class="n">count</span><span class="p">)</span></div>
 
 

module_docs/lkj/strings.html

@@ -175,16 +175,23 @@
 
 <dl class="py function">
 <dt class="sig sig-object py" id="lkj.strings.most_common_indent">
-<span class="sig-prename descclassname"><span class="pre">lkj.strings.</span></span><span class="sig-name descname"><span class="pre">most_common_indent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../../_modules/lkj/strings.html#most_common_indent"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#lkj.strings.most_common_indent" title="Link to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">lkj.strings.</span></span><span class="sig-name descname"><span class="pre">most_common_indent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore_first_line</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../../_modules/lkj/strings.html#most_common_indent"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#lkj.strings.most_common_indent" title="Link to this definition"></a></dt>
 <dd><p>Find the most common indentation in a string.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>string</strong> – The string to analyze.</p>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>string</strong> – The string to analyze.</p></li>
+<li><p><strong>ignore_first_line</strong> – Whether to ignore the first line when determining the
+indentation. Default is False. One case where you want True is when using python
+triple quotes (as in docstrings, for example), since the first line often has
+no indentation (from the point of view of the string, in this case.</p></li>
+</ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p>The most common indentation string.</p>
 </dd>
 </dl>
+<p>Examples:</p>
 <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">most_common_indent</span><span class="p">(</span><span class="s1">&#39;    This is a test.</span><span class="se">\n</span><span class="s1">    Another line.&#39;</span><span class="p">)</span>
 <span class="go">&#39;    &#39;</span>
 </pre></div>