Skip to content

Commit 5fa1915

Browse files
committed
docs(CHANGES): Note typing annotations
1 parent 7067d0f commit 5fa1915

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

CHANGES

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,19 @@ $ pip install --user --upgrade --pre libvcs
7070

7171
### Internals
7272

73+
- {issue}`362` [mypy] support added:
74+
75+
- Basic mypy tests now pass
76+
- Type annotations added, including improved typings for:
77+
78+
- {meth}`libvcs._internal.subprocess.SubprocessCommand.run`
79+
- {meth}`libvcs._internal.subprocess.SubprocessCommand.Popen`
80+
- {meth}`libvcs._internal.subprocess.SubprocessCommand.check_output`
81+
- {meth}`libvcs._internal.subprocess.run.run`
82+
83+
- `make mypy` and `make watch_mypy`
84+
- Automatic checking on CI
85+
7386
- {issue}`345` `libvcs.utils` -> `libvcs._internal` to make it more obvious the APIs are strictly
7487
closed.
7588
- `StrOrPath` -> `StrPath`
@@ -86,6 +99,9 @@ $ pip install --user --upgrade --pre libvcs
8699
### Documentation
87100

88101
- Document `libvcs.types`
102+
- {issue}`362`: Improve developer documentation to note [mypy] and have tabbed examples for flake8.
103+
104+
[mypy]: http://mypy-lang.org/
89105

90106
### Packaging
91107

0 commit comments

Comments
 (0)