Skip to content

Adds note to Readme about check-docstring-first #1160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Burhan-Q wants to merge 2 commits into from
Closed

Adds note to Readme about check-docstring-first #1160

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8255d78
include note regarding `check-docstring-first`
Burhan-Q Apr 25, 2025
ff3abec
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down