Skip to content

Commit 01c9126

Browse files
Add missing option to readme (#446)
* Update readme for missing option. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 8d565a5 commit 01c9126

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,9 @@ The following configuration options are accepted:
6262
`module.for.Class`). If `False`, just the class name displays (e.g. `Class`)
6363
- `always_document_param_types` (default: `False`): If `False`, do not add type info for undocumented parameters. If
6464
`True`, add stub documentation for undocumented parameters to be able to add type info.
65+
- `always_use_bars_union ` (default: `False`): If `True`, display Union's using the | operator described in PEP 604.
66+
(e.g `X` | `Y` or `int` | `None`). If `False`, Unions will display with the typing in brackets. (e.g. `Union[X, Y]`
67+
or `Optional[int]`)
6568
- `typehints_document_rtype` (default: `True`): If `False`, never add an `:rtype:` directive. If `True`, add the
6669
`:rtype:` directive if no existing `:rtype:` is found.
6770
- `typehints_use_rtype` (default: `True`): Controls behavior when `typehints_document_rtype` is set to `True`. If

0 commit comments

Comments
 (0)