You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I think it would be cool to explicitly tell autodocnot to document the return type automatically when autodoc_typehints in {"description", "both"}.
Indeed, it is generally ugly when documenting a tuple return type such as the following.
deffoo(): ->tuple[int, int]:
"""Foooo. Returns ------- a: int Bar. b: int Baz. """return0, 1
Note that the napoleon option napoleon_use_rtype = Falsedoes not work, and also, one cannot use the autodoc-process-docstring event since the return type specification seems to be added after it...
Options could be "all", "none", "undocumented" for example.
All the best!
Élie.
The text was updated successfully, but these errors were encountered:
Hi there,
I think it would be cool to explicitly tell
autodoc
not to document the return type automatically whenautodoc_typehints in {"description", "both"}
.Indeed, it is generally ugly when documenting a
tuple
return type such as the following.Note that the
napoleon
optionnapoleon_use_rtype = False
does not work, and also, one cannot use theautodoc-process-docstring
event since the return type specification seems to be added after it...Options could be
"all", "none", "undocumented"
for example.All the best!
Élie.
The text was updated successfully, but these errors were encountered: