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 docs: docs for show_return_annotation param for stringify_signature() is not explained

Browse Source
This commit is contained in:
Takeshi KOMIYA
2021-12-25 19:57:17 +09:00
parent 4f9b4c2124
commit 287dd515e2
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
sphinx/util/inspect.py
View File

@@ -748,8 +748,9 @@ def stringify_signature(sig: inspect.Signature, show_annotation: bool = True,
unqualified_typehints: bool = False) -> str:
"""Stringify a Signature object.
:param show_annotation: Show annotation in result
:param unqualified_typehints: Show annotations as unqualified
:param show_annotation: If enabled, show annotations on the signature
:param show_return_annotation: If enabled, show annotation of the return value
:param unqualified_typehints: If enabled, show annotations as unqualified
(ex. io.StringIO -> StringIO)
"""
args = []