pre-commit/pre-commit-hooks
1
0
Fork 0
mirror of https://github.com/pre-commit/pre-commit-hooks.git synced 2026-03-29 02:16:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

deprecate check-docstring-first without replacement

Browse source 
this hook has unfixable false positives and is not that useful

perhaps someone can write a flake8 plugin to replace the functionality
This commit is contained in:
anthony sottile 2025-11-22 15:09:09 -05:00
parent f4e025486b
commit d2cf95b9cf
2 changed files with 3 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.pre-commit-hooks.yaml
View file

@ -29,7 +29,7 @@
entry: check-case-conflict
language: python
- id: check-docstring-first
name: check docstring is first
name: check docstring is first (deprecated)
description: checks a common error of defining a docstring after code.
entry: check-docstring-first
language: python

5
README.md
View file

@ -45,9 +45,6 @@ Require literal syntax when initializing empty or zero Python builtin types.
#### `check-case-conflict`
Check for files with names that would conflict on a case-insensitive filesystem like MacOS HFS+ or Windows FAT.
#### `check-docstring-first`
Checks for a common error of placing code before the docstring.
#### `check-executables-have-shebangs`
Checks that non-binary executables have a proper shebang.
@ -207,6 +204,8 @@ Trims trailing whitespace.
- `check-byte-order-marker`: instead use fix-byte-order-marker
- `fix-encoding-pragma`: instead use [`pyupgrade`](https://github.com/asottile/pyupgrade)
- `check-docstring-first`: fundamentally flawed, deprecated without replacement.
### As a standalone package