Skip to content

Commit 13ca2b4

Browse files
[pre-commit.ci] pre-commit autoupdate (#226)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent def37f7 commit 13ca2b4

File tree

3 files changed

+11
-10
lines changed

3 files changed

+11
-10
lines changed

.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
repos:
22
- repo: https://github.com/pre-commit/pre-commit-hooks
3-
rev: v4.1.0
3+
rev: v4.2.0
44
hooks:
55
- id: check-ast
66
- id: check-builtin-literals
@@ -12,7 +12,7 @@ repos:
1212
- id: end-of-file-fixer
1313
- id: trailing-whitespace
1414
- repo: https://github.com/asottile/pyupgrade
15-
rev: v2.31.1
15+
rev: v2.32.0
1616
hooks:
1717
- id: pyupgrade
1818
args: [ "--py37-plus" ]

CHANGELOG.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515

1616
## 1.16.0
1717

18-
- Add support for type subscriptions with multiple elements, where one or more elements
19-
are tuples; e.g., `nptyping.NDArray[(Any, ...), nptyping.Float]`
18+
- Add support for type subscriptions with multiple elements, where one or more elements are tuples; e.g.,
19+
`nptyping.NDArray[(Any, ...), nptyping.Float]`
2020
- Fix bug for arbitrary types accepting singleton subscriptions; e.g., `nptyping.Float[64]`
2121
- Resolve forward references
2222
- Expand and better handle `TypeVar`
@@ -29,7 +29,8 @@ are tuples; e.g., `nptyping.NDArray[(Any, ...), nptyping.Float]`
2929
## 1.15.2
3030

3131
- Log a warning instead of crashing when a type guard import fails to resolve
32-
- When resolving type guard imports if the target module does not have source code (such is the case for C-extension modules) do nothing instead of crashing
32+
- When resolving type guard imports if the target module does not have source code (such is the case for C-extension
33+
modules) do nothing instead of crashing
3334

3435
## 1.15.1
3536

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,11 @@ The following configuration options are accepted:
5959
`True`, add stub documentation for undocumented parameters to be able to add type info.
6060
- `typehints_document_rtype` (default: `True`): If `False`, never add an `:rtype:` directive. If `True`, add the
6161
`:rtype:` directive if no existing `:rtype:` is found.
62-
- `typehints_use_rtype` (default: `True`):
63-
Controls behavior when `typehints_document_rtype` is set to `True`.
64-
If `True`, document return type in the `:rtype:` directive.
65-
If `False`, document return type as part of the `:return:` directive, if present, otherwise fall back to using `:rtype:`.
66-
Use in conjunction with [napoleon_use_rtype](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#confval-napoleon_use_rtype) to avoid generation of duplicate or redundant return type information.
62+
- `typehints_use_rtype` (default: `True`): Controls behavior when `typehints_document_rtype` is set to `True`. If
63+
`True`, document return type in the `:rtype:` directive. If `False`, document return type as part of the `:return:`
64+
directive, if present, otherwise fall back to using `:rtype:`. Use in conjunction with
65+
[napoleon_use_rtype](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#confval-napoleon_use_rtype)
66+
to avoid generation of duplicate or redundant return type information.
6767
- `typehints_defaults` (default: `None`): If `None`, defaults are not added. Otherwise adds a default annotation:
6868

6969
- `'comma'` adds it after the type, changing Sphinx’ default look to “**param** (_int_, default: `1`) -- text”.

0 commit comments

Comments
 (0)