Handle case where description is empty (#140)

numpy · Nov 4, 2017 · 8c1e85c · 8c1e85c
1 parent 5b1169f
commit 8c1e85c
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/doc/example.py b/doc/example.py
@@ -62,6 +62,7 @@ def foo(var1, var2, long_var_name='hi'):
         Explanation of return value named `describe`.
     out : type
         Explanation of `out`.
+    type_without_description
 
     Other Parameters
     ----------------

diff --git a/numpydoc/docscrape_sphinx.py b/numpydoc/docscrape_sphinx.py
@@ -200,10 +200,12 @@ def _str_param_list(self, name, fake_autosummary=False):
                                                           param_type)])
                 else:
                     out += self._str_indent([display_param])
-                if desc:
-                    if self.use_blockquotes:
-                        out += ['']
-                    out += self._str_indent(desc, 8)
+                if desc and self.use_blockquotes:
+                    out += ['']
+                elif not desc:
+                    # empty definition
+                    desc = ['..']
+                out += self._str_indent(desc, 8)
                 out += ['']
 
         return out

diff --git a/numpydoc/tests/test_docscrape.py b/numpydoc/tests/test_docscrape.py
@@ -1147,6 +1147,7 @@ def no_period(self):
             But a description
 
         no_docstring2 : str
+            ..
 
         :obj:`multiline_sentence <multiline_sentence>`
             This is a sentence.