Skip to content

Commit a9b9023

Browse files
authored
Fix typos (#224)
1 parent 1ef8488 commit a9b9023

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The following configuration options are accepted:
7171
- `'braces-after'` adds `(default: ...)` at the end of the parameter documentation text instead.
7272

7373
- `simplify_optional_unions` (default: `True`): If `True`, optional parameters of type \"Union\[\...\]\" are simplified
74-
as being of type Union\[\..., None\] in the resulting documention (e.g. Optional\[Union\[A, B\]\] -\> Union\[A, B,
74+
as being of type Union\[\..., None\] in the resulting documentation (e.g. Optional\[Union\[A, B\]\] -\> Union\[A, B,
7575
None\]). If `False`, the \"Optional\"-type is kept. Note: If `False`, **any** Union containing `None` will be
7676
displayed as Optional! Note: If an optional parameter has only a single type (e.g Optional\[A\] or Union\[A, None\]),
7777
it will **always** be displayed as Optional!
@@ -109,7 +109,7 @@ On Python 3.7, you can even use `from __future__ import annotations` and remove
109109

110110
If you\'re documenting code that needs to stay compatible with Python 2.7, you cannot use regular type annotations.
111111
Instead, you must either be using Python 3.8 or later or have [typed_ast](https://pypi.org/project/typed-ast/)
112-
installed. The package extras `type_comments` will pull in the appropiate dependencies automatically. Then you can add
112+
installed. The package extras `type_comments` will pull in the appropriate dependencies automatically. Then you can add
113113
type hint comments in the following manner:
114114

115115
```python

0 commit comments

Comments
 (0)