We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 29b9eed commit 4611c05Copy full SHA for 4611c05
numpydoc/docscrape.py
@@ -199,6 +199,14 @@ def _read_to_next_section(self):
199
200
return section
201
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
+
210
def _read_sections(self):
211
while not self._doc.eof():
212
data = self._read_to_next_section()
@@ -221,6 +229,7 @@ def _parse_param_list(self, content):
221
229
else:
222
230
arg_name, arg_type = header, ''
223
231
232
+ arg_name = self._escape_args_and_kwargs(arg_name)
224
233
desc = r.read_to_next_unindented_line()
225
234
desc = dedent_lines(desc)
226
235
desc = strip_blank_lines(desc)
0 commit comments