Merge pull request #9668 from tk0miya/9655_mocked_object_having_doccomment

Fix #9655: autodoc: mocked object having doc comment is warned unexpectedly
This commit is contained in:
Takeshi KOMIYA
2021-09-26 00:55:10 +09:00
committed by GitHub
2 changed files with 6 additions and 4 deletions

View File

@@ -23,6 +23,7 @@ Bugs fixed
* #9630: autodoc: Failed to build cross references if :confval:`primary_domain`
is not 'py'
* #9644: autodoc: Crashed on getting source info from problematic object
* #9655: autodoc: mocked object having doc comment is warned unexpectedly
* #9630: autosummary: Failed to build summary table if :confval:`primary_domain`
is not 'py'
* #9670: html: Fix download file with special characters

View File

@@ -913,10 +913,6 @@ class Documenter:
if not self.import_object():
return
if ismock(self.object):
logger.warning(__('A mocked object is detected: %r'),
self.name, type='autodoc')
# If there is no real module defined, figure out which to use.
# The real module is used in the module analyzer to look up the module
# where the attribute documentation would actually be found in.
@@ -949,6 +945,11 @@ class Documenter:
except PycodeError:
pass
docstrings: List[str] = sum(self.get_doc() or [], [])
if ismock(self.object) and not docstrings:
logger.warning(__('A mocked object is detected: %r'),
self.name, type='autodoc')
# check __module__ of object (for members not given explicitly)
if check_module:
if not self.check_module():