IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

escape combined args and kwargs for numpy docstrings

Browse Source
This commit is contained in:
Keewis 2020-06-08 13:43:09 +02:00
parent 9834f775ae
commit 4d36cccd74
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
sphinx/ext/napoleon/docstring.py
View File

@ -876,6 +876,16 @@ class NumpyDocstring(GoogleDocstring):
self._directive_sections = ['.. index::']
super().__init__(docstring, config, app, what, name, obj, options)
def _escape_args_and_kwargs(self, name):
if ", " in name:
parts = name.split(", ")
return ", ".join(
super()._escape_args_and_kwargs(part)
for part in parts
)
return super()._escape_args_and_kwargs(name)
def _consume_field(self, parse_type: bool = True, prefer_type: bool = False
) -> Tuple[str, str, List[str]]:
line = next(self._line_iter)