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

Fix #7435: autodoc_typehints doesn't suppress typehints for classes/methods

Browse Source
This commit is contained in:
Takeshi KOMIYA 2020-04-09 01:15:21 +09:00
parent 4caa7d7c37
commit 0525c39b9e
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -17,6 +17,8 @@ Bugs fixed
---------- ----------
* #7428: py domain: a reference to class ``None`` emits a nitpicky warning * #7428: py domain: a reference to class ``None`` emits a nitpicky warning
* #7435: autodoc: ``autodoc_typehints='description'`` doesn't suppress typehints
in signature for classes/methods
Testing Testing
-------- --------

4
sphinx/ext/autodoc/__init__.py
View File

@ -1174,7 +1174,7 @@ class ClassDocumenter(DocstringSignatureMixin, ModuleLevelDocumenter): # type:
return ret return ret
def format_args(self, **kwargs: Any) -> str: def format_args(self, **kwargs: Any) -> str:
if self.env.config.autodoc_typehints == 'none': if self.env.config.autodoc_typehints in ('none', 'description'):
kwargs.setdefault('show_annotation', False) kwargs.setdefault('show_annotation', False)
# for classes, the relevant signature is the __init__ method's # for classes, the relevant signature is the __init__ method's
@ -1430,7 +1430,7 @@ class MethodDocumenter(DocstringSignatureMixin, ClassLevelDocumenter): # type:
return ret return ret
def format_args(self, **kwargs: Any) -> str: def format_args(self, **kwargs: Any) -> str:
if self.env.config.autodoc_typehints == 'none': if self.env.config.autodoc_typehints in ('none', 'description'):
kwargs.setdefault('show_annotation', False) kwargs.setdefault('show_annotation', False)
unwrapped = inspect.unwrap(self.object) unwrapped = inspect.unwrap(self.object)