forked from sphinx-doc/sphinx
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Previously, if autodoc_typehints="description", a :type: field would be added for every parameter and return type appearing in the annotation, including **kwargs and underscore-prefixed parameters that are meant to be private, as well as None return types. This commit introduces a new option, "autodoc_typehint_undoc". By default this option is True, requesting the old behavior. By setting this option to False, :type: and :rtype: fields will only be added for annotated parameters or return types if there is already a corresponding :param: or :return: field, to put users in control over whether a given parameter is documented or not.
- Loading branch information
Showing
3 changed files
with
66 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters