Format and add linting rules/github action #88
Merged
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
Signed-off-by: jamshale <[email protected]>
PatStLouis
approved these changes
Jan 15, 2025
Comment on lines
+47
to
+63
| lint.ignore = [ | ||
| # Google Python Doc Style | ||
| "D203", | ||
| "D204", | ||
| "D213", | ||
| "D215", | ||
| "D400", | ||
| "D401", | ||
| "D404", | ||
| "D406", | ||
| "D407", | ||
| "D408", | ||
| "D409", | ||
| "D413", | ||
| "D202", # Allow blank line after docstring | ||
| "D104", # Don't require docstring in public package | ||
| ] |
There was a problem hiding this comment.
How can I find more information about these?
There was a problem hiding this comment.
The D rules can be found in pydocstyle https://www.pydocstyle.org/en/2.1.1/error_codes.html
There was a problem hiding this comment.
https://docs.astral.sh/ruff/rules/#pydocstyle-d ruff has an extensive list. It's probably the best for all the rules.
PatStLouis
reviewed
Jan 16, 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 adds lint rules to the server project. The same as in acapy projects. Most of the documentation is just generated by copilot and not super useful, but I still think it's good if more developers and work gets done on this project.
Basic github action on PR's.
Would recommend using a ruff extension for vscode or other ide when working in this project.