Skip to content

Commit 26be104

Browse files
committed
Improve darglint related upgrading notes.
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 06914ae commit 26be104

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

RELEASE_NOTES.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@ This release replaces [`darglint`](https://github.com/terrencepreilly/darglint)
88

99
- `flake8` basic checks are enabled now. Most are already covered by `pylint`, but there are a few differences, so you might need to fix your code if `flake8` find some issues.
1010

11-
- `darglint` was replaced by `pydoclint`, `pydoclint` can find a few more issues than `darglint`, so your code might need adjusting.
11+
- `darglint`:
1212

13-
- `darglint` is not used anymore, but if it is installed, it will make `flake8` run extremely slowly anyways, so it is extremely recommended to uninstall it (`pip uninstall darglint`) and rebuild you `nox` *venvs* if you use `-R`.
13+
* Replaced by `pydoclint`, `pydoclint` can find a few more issues than `darglint`, so your code might need adjusting.
14+
15+
* It is recommended to remove the `darglint` configuration file `.darglint` and the `darglint` `pip` package, if it is kept installed, it will make `flake8` run extremely slowly even if not used: `pip uninstall darglint`) and rebuild you `nox` *venvs* if you use `-R`.
1416

1517
- If you are upgrading without regenerating the cookiecutter templates, you'll need to adjust the dependencies accordingly.
1618

0 commit comments

Comments
 (0)