Skip to content

Commit 050a6e6

Browse files
committed
Move arg and kwargs escaping to docscrape_sphinx
1 parent 8fa0098 commit 050a6e6

File tree

2 files changed

+9
-10
lines changed

2 files changed

+9
-10
lines changed

numpydoc/docscrape.py

-9
Original file line numberDiff line numberDiff line change
@@ -199,14 +199,6 @@ 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-
210202
def _read_sections(self):
211203
while not self._doc.eof():
212204
data = self._read_to_next_section()
@@ -229,7 +221,6 @@ def _parse_param_list(self, content):
229221
else:
230222
arg_name, arg_type = header, ''
231223

232-
arg_name = self._escape_args_and_kwargs(arg_name)
233224
desc = r.read_to_next_unindented_line()
234225
desc = dedent_lines(desc)
235226
desc = strip_blank_lines(desc)

numpydoc/docscrape_sphinx.py

+9-1
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,14 @@ def _str_returns(self, name='Returns'):
8888
out += ['']
8989
return out
9090

91+
def _escape_args_and_kwargs(self, name):
92+
if name[:2] == '**':
93+
return r'\*\*' + name[2:]
94+
elif name[:1] == '*':
95+
return r'\*' + name[1:]
96+
else:
97+
return name
98+
9199
def _process_param(self, param, desc, fake_autosummary):
92100
"""Determine how to display a parameter
93101
@@ -122,7 +130,7 @@ def _process_param(self, param, desc, fake_autosummary):
122130
complicated to incorporate autosummary's signature mangling, as it
123131
relies on Sphinx's plugin mechanism.
124132
"""
125-
param = param.strip()
133+
param = self._escape_args_and_kwargs(param.strip())
126134
# XXX: If changing the following, please check the rendering when param
127135
# ends with '_', e.g. 'word_'
128136
# See https://github.com/numpy/numpydoc/pull/144

0 commit comments

Comments
 (0)