Merge pull request #6457 from tk0miya/6455_napoleon_ignores_properties

Fix #6455: napoleon: docstrings for properties are not processed
sphinx-doc · Jun 9, 2019 · 783de00 · 783de00
2 parents dc540e2 + 4945628
commit 783de00
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/CHANGES b/CHANGES
@@ -20,6 +20,7 @@ Bugs fixed
   immediately preceding section title by pagebreak
 * #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
 
 Testing
 --------

diff --git a/sphinx/ext/napoleon/docstring.py b/sphinx/ext/napoleon/docstring.py
@@ -555,7 +555,7 @@ def _parse(self):
         # type: () -> None
         self._parsed_lines = self._consume_empty()
 
-        if self._name and (self._what == 'attribute' or self._what == 'data'):
+        if self._name and self._what in ('attribute', 'data', 'property'):
             # Implicit stop using StopIteration no longer allowed in
             # Python 3.7; see PEP 479
             res = []  # type: List[str]