Merge pull request #6460 from tk0miya/6436_napoleon_unknown_target_name

Fix #6436: napoleon: "Unknown target name" error
This commit is contained in:
Takeshi KOMIYA
2019-06-10 01:09:42 +09:00
committed by GitHub
3 changed files with 7 additions and 2 deletions
+2
View File
@@ -21,6 +21,8 @@ Bugs fixed
* #6448: autodoc: crashed when autodocumenting classes with ``__slots__ = None``
* #6452: autosummary: crashed when generating document of properties
* #6455: napoleon: docstrings for properties are not processed
* #6436: napoleon: "Unknown target name" error if variable name ends with
underscore
Testing
--------
+3
View File
@@ -328,6 +328,9 @@ class GoogleDocstring:
def _escape_args_and_kwargs(self, name):
# type: (str) -> str
if name.endswith('_'):
name = name[:-1] + r'\_'
if name[:2] == '**':
return r'\*\*' + name[2:]
elif name[:1] == '*':
+2 -2
View File
@@ -1351,8 +1351,8 @@ arg_ : type
"""
expected = """
:ivar arg_: some description
:vartype arg_: type
:ivar arg\\_: some description
:vartype arg\\_: type
"""
config = Config(napoleon_use_ivar=True)