Test autosummary-like behaviour

And remove quirky 'or not desc' case

Author: jnothman

numpydoc/docscrape_sphinx.py

@@ -107,7 +107,7 @@ def _str_param_list(self, name, fake_autosummary=False):
                         param_obj = None
                     obj_doc = pydoc.getdoc(param_obj)
 
-                    if param_obj and (obj_doc or not desc):
+                    if param_obj and obj_doc:
                         # Referenced object has a docstring
                         autosum += ["    %s%s" % (autosum_prefix, param)]
                         # TODO: add signature to display as in autosummary
@@ -122,7 +122,8 @@ def _str_param_list(self, name, fake_autosummary=False):
                             desc = re.split('\n\s*\n', obj_doc.strip(), 1)[0]
                             # XXX: Should this have DOTALL?
                             #      It does not in autosummary
-                            m = re.search(r"^([A-Z].*?\.)(?:\s|$)", desc)
+                            m = re.search(r"^([A-Z].*?\.)(?:\s|$)",
+                                          ' '.join(desc.split()))
                             if m:
                                 desc = m.group(1).strip()
                             else:
@@ -183,7 +184,7 @@ def _str_member_list(self, name):
                         or inspect.isgetsetdescriptor(param_obj)):
                     param_obj = None
 
-                if param_obj and (pydoc.getdoc(param_obj) or not desc):
+                if param_obj and pydoc.getdoc(param_obj):
                     # Referenced object has a docstring
                     autosum += ["   %s%s" % (prefix, param)]
                 else:

numpydoc/tests/test_docscrape.py

@@ -899,8 +899,17 @@ def test_duplicate_signature():
         Current time.
     y : ndarray
         Current variable values.
-    x : float
-        Some parameter
+
+        * hello
+        * world
+    an_attribute : float
+        The docstring is printed instead
+    no_docstring : str
+        But a description
+    no_docstring2 : str
+    multiline_sentence
+    midword_period
+    no_period
 
     Methods
     -------
@@ -936,8 +945,17 @@ def test_class_members_doc():
         Current time.
     y : ndarray
         Current variable values.
-    x : float
-        Some parameter
+
+        * hello
+        * world
+    an_attribute : float
+        The docstring is printed instead
+    no_docstring : str
+        But a description
+    no_docstring2 : str
+    multiline_sentence
+    midword_period
+    no_period
 
     Methods
     -------
@@ -954,10 +972,38 @@ def test_class_members_doc():
 def test_class_members_doc_sphinx():
     class Foo:
         @property
-        def x(self):
+        def an_attribute(self):
             """Test attribute"""
             return None
 
+        @property
+        def no_docstring(self):
+            return None
+
+        @property
+        def no_docstring2(self):
+            return None
+
+        @property
+        def multiline_sentence(self):
+            """This is a
+            sentence. It spans multiple lines."""
+            return None
+
+        @property
+        def midword_period(self):
+            """The sentence for numpy.org."""
+            return None
+
+        @property
+        def no_period(self):
+            """This does not have a period
+            so we truncate its summary to the first linebreak
+
+            Apparently.
+            """
+            return None
+
     doc = SphinxClassDoc(Foo, class_doc_txt)
     non_blank_line_by_line_compare(str(doc),
     """
@@ -983,15 +1029,30 @@ def x(self):
             Current time.
         **y** : ndarray
             Current variable values.
-        :obj:`x <x>` : float
+
+            * hello
+            * world
+        :obj:`an_attribute <an_attribute>` : float
             Test attribute
+        **no_docstring** : str
+            But a description
+        **no_docstring2** : str
+        :obj:`multiline_sentence <multiline_sentence>`
+            This is a sentence.
+        :obj:`midword_period <midword_period>`
+            The sentence for numpy.org.
+        :obj:`no_period <no_period>`
+            This does not have a period
 
     ..
         HACK to make autogen generate docs:
         .. autosummary::
             :toctree:
 
-            x
+            an_attribute
+            multiline_sentence
+            midword_period
+            no_period
 
     .. rubric:: Methods