Skip to content

Commit 06396a5

Browse files
authored
Merge branch 'master' into bold
2 parents 5ed44e0 + 8c1e85c commit 06396a5

File tree

3 files changed

+8
-4
lines changed

3 files changed

+8
-4
lines changed

doc/example.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ def foo(var1, var2, long_var_name='hi'):
6262
Explanation of return value named `describe`.
6363
out : type
6464
Explanation of `out`.
65+
type_without_description
6566
6667
Other Parameters
6768
----------------

numpydoc/docscrape_sphinx.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -198,10 +198,12 @@ def _str_param_list(self, name, fake_autosummary=False):
198198
param_type)])
199199
else:
200200
out += self._str_indent([display_param])
201-
if desc:
202-
if self.use_blockquotes:
203-
out += ['']
204-
out += self._str_indent(desc, 8)
201+
if desc and self.use_blockquotes:
202+
out += ['']
203+
elif not desc:
204+
# empty definition
205+
desc = ['..']
206+
out += self._str_indent(desc, 8)
205207
out += ['']
206208

207209
return out

numpydoc/tests/test_docscrape.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1147,6 +1147,7 @@ def no_period(self):
11471147
But a description
11481148
11491149
**no_docstring2** : str
1150+
..
11501151
11511152
:obj:`multiline_sentence <multiline_sentence>`
11521153
This is a sentence.

0 commit comments

Comments
 (0)