chore(lint): enable Ruff's pydocstyle (D) rules #15
Conversation
This file contains hidden or 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
gazpachoking
requested changes
Jul 27, 2025
Collaborator
gazpachoking
left a comment
gazpachoking
left a comment
There was a problem hiding this comment.
All look good, except I think the AtrtibuteGenerator and datastar_response docstrings are a little worse with this change. I think we can just disable the imperative mood rule and leave those two as is.
This commit updates the linter configuration to enable the `pydocstyle` rule set, which is identified by the "D" prefix in Ruff. Enforcing docstring conventions will help improve code clarity and make the project easier to maintain and for new contributors to understand.
Contributor
Author
|
I’ve already ignored the rule, but maybe it would be better to enable it and use |
Collaborator
I think it's fine like this at least for now, thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 commit updates the linter configuration to enable the
pydocstylerule set, which is identified by the "D" prefix in Ruff.Enforcing docstring conventions will help improve code clarity and make the project easier to maintain and for new contributors to understand.