Fixes #5426: [Napoleon] Better handling of inline attributes (#5470)

* Fixes #5426: [Napoleon] Better handling of inline attributes

* Removes uneeded NOQA comments

* Fixes imports
This commit is contained in:
Rob Ruana
2018-09-23 09:26:17 -04:00
committed by GitHub
parent bd1e33643c
commit e547a6a0d2
4 changed files with 38 additions and 8 deletions

View File

@@ -77,6 +77,34 @@ Sample namedtuple subclass
self.assertEqual(expected, actual)
class InlineAttributeTest(BaseDocstringTest):
def test_class_data_member(self):
config = Config()
docstring = """data member description:
- a: b
"""
actual = str(GoogleDocstring(docstring, config=config, app=None,
what='attribute', name='some_data', obj=0))
expected = """data member description:
- a: b"""
self.assertEqual(expected, actual)
def test_class_data_member_inline(self):
config = Config()
docstring = """b: data member description with :ref:`reference`"""
actual = str(GoogleDocstring(docstring, config=config, app=None,
what='attribute', name='some_data', obj=0))
expected = """data member description with :ref:`reference`
:type: b"""
self.assertEqual(expected, actual)
class GoogleDocstringTest(BaseDocstringTest):
docstrings = [(
"""Single line summary""",