-
Notifications
You must be signed in to change notification settings - Fork 26
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.
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
feat: [FC-0074] add linter for Open edX Filters classes definitions #480
base: master
Are you sure you want to change the base?
feat: [FC-0074] add linter for Open edX Filters classes definitions #480
Conversation
Thanks for the pull request, @mariajgrimaldi! This repository is currently maintained by @openedx/axim-engineering. Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.
|
I pinged the Axim eng team in slack to see if anyone has an opinion on this - I don't, but I'm not a primary maintainer of this repo. |
Thank you, @sarina! I'll tag @openedx/axim-engineering here as the owners according to the catalog-info.yaml. |
Description:
This PR adds a custom linter for Open edX Filter classes docstrings to check whether new filters follow the specified format:
If a class is missing at least one of the section, then a pylint error is raised:
You can see the linter integrated into the repo in this PR: openedx/openedx-filters#249
I'm open to moving this directly into the openedx-filters repo if needed, considering that the linter is kind of specific to that repository.
Merge checklist: