fix: remove check-docstring-first pre-commit check #1531
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This check gives false positives on attribute docstrings with warnings such as: - "Multiple module docstrings (first docstring on line N)", or - "Module docstring appears after code (code seen on line N)" For details, see: pre-commit/pre-commit-hooks#159
|
In the discussion of pre-commit/pre-commit-hooks#159 , Several other projects chose to remove this check such as: DanielNoord/jsonschema@8304e41 |
|
This is needed for this PR: #1530 |
|
@rodrigc Appreciate the work, thanks for taking the time! Can I suggested instead of removing the check, should we replace it with one that you suggested? |
|
@Fokko I dont see any way around this other than removing this check. #1530 is blocked on this and @pawamoy , who is the maintainer of mkdocstrings, suggested doing this: #1530 (comment) |
|
@rodrigc Ah, I misread the comment. Let's remove it for now then |
Fokko
approved these changes
Jan 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This check gives false positives on attribute docstrings with warnings
such as:
For details, see:
pre-commit/pre-commit-hooks#159