Skip to content

Commit 57ea3d5

Browse files
committed
Recomment only the Flake8 pre-commit hook.
1 parent b90425c commit 57ea3d5

2 files changed

Lines changed: 8 additions & 18 deletions

File tree

PyPI.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ proposal ([#234]) was closed as "too heated", subsequent feature
88
and pull requests were marked as "spam" ([#1332], [#1421], [#1431],
99
[#1447], [#1501]).
1010

11-
*Flake8-pyproject* also has bad manners and force-feeds Flake8 the
11+
Flake8-pyproject also has bad manners and force-feeds Flake8 the
1212
spam it so despises. It registers itself as a Flake8 plug-in to
1313
seamlessly load the configuration from `pyproject.toml` when you
1414
run the `flake8` command.

ReadMe.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ proposal ([#234]) was closed as "too heated", subsequent feature
88
and pull requests were marked as "spam" ([#1332], [#1421], [#1431],
99
[#1447], [#1501]).
1010

11-
*Flake8-pyproject* also has bad manners and force-feeds Flake8 the
11+
Flake8-pyproject also has bad manners and force-feeds Flake8 the
1212
spam it so despises. It registers itself as a Flake8 plug-in to
1313
seamlessly load the configuration from `pyproject.toml` when you
1414
run the `flake8` command.
@@ -90,22 +90,9 @@ when `pyproject.toml` isn't found.
9090

9191
## Pre-commit hook
9292

93-
When using the `flake8p` (not `flake8`) entry point, and you want to
94-
run it on every `git commit`, add the following to your project's
95-
pre-commit configuration `.pre-commit-config.yaml`:
96-
97-
```yaml
98-
- repo: https://github.com/john-hen/Flake8-pyproject
99-
rev: 1.2.1
100-
hooks:
101-
- id: Flake8-pyproject
102-
```
103-
104-
Change the revision to whatever is the latest release version.
105-
106-
Note that you could just use the pre-commit hook for Flake8 itself,
107-
and make sure this package here is installed, to get the same outcome:
108-
93+
Use the pre-commit hook for Flake8 itself and make sure this package
94+
here is installed as well. The pre-commit configuration, in
95+
`.pre-commit-config.yaml`, would then look like so:
10996
```yaml
11097
- repo: https://github.com/pycqa/flake8
11198
rev: 6.0.0
@@ -114,6 +101,9 @@ and make sure this package here is installed, to get the same outcome:
114101
additional_dependencies: [Flake8-pyproject]
115102
```
116103
104+
Change the revision to whatever is the latest release version of
105+
Flake8.
106+
117107
118108
[![release](
119109
https://img.shields.io/pypi/v/Flake8-pyproject.svg?label=release)](

0 commit comments

Comments
 (0)