Skip to content

Commit 4611c05

Browse files
committed
Escape the * in *args and **kwargs
Prevents sphinx from complaining `WARNING: Inline strong start-string without end-string.` Credit: Solution taken directly from sphinx.ext.napoleon
1 parent 29b9eed commit 4611c05

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

numpydoc/docscrape.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,14 @@ def _read_to_next_section(self):
199199

200200
return section
201201

202+
def _escape_args_and_kwargs(self, name):
203+
if name[:2] == '**':
204+
return r'\*\*' + name[2:]
205+
elif name[:1] == '*':
206+
return r'\*' + name[1:]
207+
else:
208+
return name
209+
202210
def _read_sections(self):
203211
while not self._doc.eof():
204212
data = self._read_to_next_section()
@@ -221,6 +229,7 @@ def _parse_param_list(self, content):
221229
else:
222230
arg_name, arg_type = header, ''
223231

232+
arg_name = self._escape_args_and_kwargs(arg_name)
224233
desc = r.read_to_next_unindented_line()
225234
desc = dedent_lines(desc)
226235
desc = strip_blank_lines(desc)

0 commit comments

Comments
 (0)