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

include note regarding check-docstring-first

Browse source
This commit is contained in:
Burhan 2025-04-25 16:46:54 -04:00 • committed by GitHub
parent 5c514f85cc
commit 8255d780c5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -48,6 +48,20 @@ Check for files with names that would conflict on a case-insensitive filesystem
#### `check-docstring-first`
Checks for a common error of placing code before the docstring.
> [!NOTE]
> As raised in [#159](https://github.com/pre-commit/pre-commit-hooks/issues/159) attribute level docstrings will
> be flagged by this. A basic workaround is to wrap the docstring with `()` which will bypass this throwing and
> error, but could interfere with other libraries that parse them.
<details><summary>Example</summary>
```python
variable = 42
("""Attribute docstring""")
```
</details>
#### `check-executables-have-shebangs`
Checks that non-binary executables have a proper shebang.