fix multiline strings

Author: mhils

pdoc/docstrings.py

@@ -193,7 +193,7 @@ def numpy(docstring: str) -> str:
     )
     contents = sections[0]
     for heading, content in zip(sections[1::2], sections[2::2]):
-        if content.startswith(" ") and "\n" in content:
+        if content.startswith(" ") and re.search(r"\n(?![ \n])", content):
             # If the first line of section content is indented, we consider the section to be finished
             # on the first non-indented line. We take out the rest - the tail - here.
             content, tail = re.split(r"\n(?![ \n])", content, maxsplit=1)

test/testdata/flavors_numpy.html

@@ -104,6 +104,9 @@ <h2>API Documentation</h2>
             <li>
                     <a class="function" href="#invalid_format2">invalid_format2</a>
             </li>
+            <li>
+                    <a class="function" href="#invalid_format3">invalid_format3</a>
+            </li>
     </ul>
 
 
@@ -650,6 +653,14 @@ <h6 id="attributes">Attributes</h6>
 </span><span id="L-484"><a href="#L-484"><span class="linenos">484</span></a><span class="sd">    -------</span>
 </span><span id="L-485"><a href="#L-485"><span class="linenos">485</span></a><span class="sd">        Text describing the return value.</span>
 </span><span id="L-486"><a href="#L-486"><span class="linenos">486</span></a><span class="sd">    &quot;&quot;&quot;</span>
+</span><span id="L-487"><a href="#L-487"><span class="linenos">487</span></a>
+</span><span id="L-488"><a href="#L-488"><span class="linenos">488</span></a><span class="k">def</span><span class="w"> </span><span class="nf">invalid_format3</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+</span><span id="L-489"><a href="#L-489"><span class="linenos">489</span></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+</span><span id="L-490"><a href="#L-490"><span class="linenos">490</span></a><span class="sd">    Returns</span>
+</span><span id="L-491"><a href="#L-491"><span class="linenos">491</span></a><span class="sd">    -------</span>
+</span><span id="L-492"><a href="#L-492"><span class="linenos">492</span></a><span class="sd">        Multiline text</span>
+</span><span id="L-493"><a href="#L-493"><span class="linenos">493</span></a><span class="sd">        describing the return value.</span>
+</span><span id="L-494"><a href="#L-494"><span class="linenos">494</span></a><span class="sd">    &quot;&quot;&quot;</span>
 </span></pre></div>
 
 
@@ -1855,6 +1866,37 @@ <h6 id="returns">Returns</h6>
 </div>
 
 
+                </section>
+                <section id="invalid_format3">
+                            <input id="invalid_format3-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
+<div class="attr function">
+            
+        <span class="def">def</span>
+        <span class="name">invalid_format3</span><span class="signature pdoc-code condensed">(<span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
+
+                <label class="view-source-button" for="invalid_format3-view-source"><span>View Source</span></label>
+
+    </div>
+    <a class="headerlink" href="#invalid_format3"></a>
+            <div class="pdoc-code codehilite"><pre><span></span><span id="invalid_format3-489"><a href="#invalid_format3-489"><span class="linenos">489</span></a><span class="k">def</span><span class="w"> </span><span class="nf">invalid_format3</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+</span><span id="invalid_format3-490"><a href="#invalid_format3-490"><span class="linenos">490</span></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+</span><span id="invalid_format3-491"><a href="#invalid_format3-491"><span class="linenos">491</span></a><span class="sd">    Returns</span>
+</span><span id="invalid_format3-492"><a href="#invalid_format3-492"><span class="linenos">492</span></a><span class="sd">    -------</span>
+</span><span id="invalid_format3-493"><a href="#invalid_format3-493"><span class="linenos">493</span></a><span class="sd">        Multiline text</span>
+</span><span id="invalid_format3-494"><a href="#invalid_format3-494"><span class="linenos">494</span></a><span class="sd">        describing the return value.</span>
+</span><span id="invalid_format3-495"><a href="#invalid_format3-495"><span class="linenos">495</span></a><span class="sd">    &quot;&quot;&quot;</span>
+</span></pre></div>
+
+
+            <div class="docstring"><h6 id="returns">Returns</h6>
+
+<ul>
+<li><strong>Multiline text</strong></li>
+<li><strong>describing the return value.</strong></li>
+</ul>
+</div>
+
+
                 </section>
     </main>
 </body>

test/testdata/flavors_numpy.py

@@ -484,3 +484,11 @@ def invalid_format2() -> None:
     -------
         Text describing the return value.
     """
+
+def invalid_format3() -> None:
+    """
+    Returns
+    -------
+        Multiline text
+        describing the return value.
+    """

test/testdata/flavors_numpy.txt

@@ -27,4 +27,7 @@
     <function def foo(var1, var2, *args, long_var_name='hi', **kwargs): ...  # Summarize the functi…>
     <function def invalid_format(test): ...  # In this example, the…>
     <function def invalid_format2() -> None: ...  # Another example with…>
+    <function def invalid_format3() -> None: ...  # Returns
+    -------
+        …>
 >