Skip to content

Commit d9e5c32

Browse files
authored
Fix option name (#196)
1 parent 1e0fee9 commit d9e5c32

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## 1.14.0
44

5-
- Added `document_defaults` config option allowing to automatically annotate parameter defaults.
5+
- Added `typehints_defaults` config option allowing to automatically annotate parameter defaults.
66

77
## 1.13.1
88

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ The following configuration options are accepted:
6161
`True`, add stub documentation for undocumented parameters to be able to add type info.
6262
- `typehints_document_rtype` (default: `True`): If `False`, never add an `:rtype:` directive. If `True`, add the
6363
`:rtype:` directive if no existing `:rtype:` is found.
64-
- `document_defaults` (default: `None`): If `None`, defaults are not added. Otherwise adds a default annotation:
64+
- `typehints_defaults` (default: `None`): If `None`, defaults are not added. Otherwise adds a default annotation:
6565

6666
- `'comma'` adds it after the type, changing Sphinx’ default look to “**param** (*int*, default: `1`) -- text”.
6767
- `'braces'` adds `(default: ...)` after the type (useful for numpydoc like styles).

0 commit comments

Comments
 (0)