Skip to content

Commit 1f0f4f2

Browse files
committed
Move arg and kwargs escaping to docscrape_sphinx
1 parent 4611c05 commit 1f0f4f2

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

numpydoc/docscrape.py

Lines changed: 0 additions & 9 deletions
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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,14 @@ def _str_returns(self, name='Returns'):
9292
out += ['']
9393
return out
9494

95+
def _escape_args_and_kwargs(self, name):
96+
if name[:2] == '**':
97+
return r'\*\*' + name[2:]
98+
elif name[:1] == '*':
99+
return r'\*' + name[1:]
100+
else:
101+
return name
102+
95103
def _process_param(self, param, desc, fake_autosummary):
96104
"""Determine how to display a parameter
97105
@@ -127,6 +135,7 @@ def _process_param(self, param, desc, fake_autosummary):
127135
relies on Sphinx's plugin mechanism.
128136
"""
129137
param = param.strip()
138+
param = self._escape_args_and_kwargs(param)
130139
display_param = ('**%s**' if self.use_blockquotes else '%s') % param
131140

132141
if not fake_autosummary:

0 commit comments

Comments
 (0)