Skip to content

Commit

Permalink
BUG: Fix returns parsing no name (#429)
Browse files Browse the repository at this point in the history
* TST: Add test case.

* MAINT: Adjust logic for parameter lines with : char.

Adjust logic in parameter line splitting to avoid bug
where Returns objects containing sphinx roles are improperly
parsed.
  • Loading branch information
rossbar committed Sep 17, 2022
1 parent 4ef89d4 commit b138ea7
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 3 deletions.
10 changes: 7 additions & 3 deletions numpydoc/docscrape.py
Original file line number Diff line number Diff line change
Expand Up @@ -226,10 +226,14 @@ def _parse_param_list(self, content, single_element_is_type=False):
params = []
while not r.eof():
header = r.read().strip()
if " :" in header:
arg_name, arg_type = header.split(" :", maxsplit=1)
arg_name, arg_type = arg_name.strip(), arg_type.strip()
if " : " in header:
arg_name, arg_type = header.split(" : ", maxsplit=1)
else:
# NOTE: param line with single element should never have a
# a " :" before the description line, so this should probably
# warn.
if header.endswith(" :"):
header = header[:-2]
if single_element_is_type:
arg_name, arg_type = "", header
else:
Expand Down
15 changes: 15 additions & 0 deletions numpydoc/tests/test_docscrape.py
Original file line number Diff line number Diff line change
Expand Up @@ -980,6 +980,21 @@ def test_empty_first_line():
)


def test_returns_with_roles_no_names():
"""Make sure colons that are part of sphinx roles are not misinterpreted
as type separator in returns section. See gh-428."""
docstring = NumpyDocString(
"""
Returns
-------
str or :class:`NumpyDocString`
"""
)
expected = "str or :class:`NumpyDocString`" # not "str or : class:...
assert docstring["Returns"][0].type == expected
assert expected in str(docstring)


def test_trailing_colon():
assert doc8["Parameters"][0].name == "data"

Expand Down

0 comments on commit b138ea7

Please sign in to comment.