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

Merge pull request #6457 from tk0miya/6455_napoleon_ignores_properties

Browse Source 
Fix #6455: napoleon: docstrings for properties are not processed
This commit is contained in:
Takeshi KOMIYA 2019-06-10 00:43:12 +09:00 committed by GitHub
commit 783de00bf0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES
View File

@ -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
--------

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

@ -555,7 +555,7 @@ class GoogleDocstring:
# 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]