-
Notifications
You must be signed in to change notification settings - Fork 17
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] use linter for openedx-filters classes definitions #249
base: main
Are you sure you want to change the base?
Conversation
Thanks for the pull request, @mariajgrimaldi! This repository is currently maintained by @openedx/hooks-extension-framework. 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.
|
d74acee
to
612b970
Compare
105a7ac
to
35ffa69
Compare
Description
This PR adds a new custom Pylint linter to check whether filter definitions docstrings follow a specific format:
Proposed in docs/reference/documenting-filters-classes.rst. The purpose of this linter is to establish a standard for developers to follow when documenting filter classes in the repository.
This PR is a continuation of #246, which enforces the format introduced in the PR.
Testing instructions
pylint openedx_filters/learning/filters.py
pylint openedx_filters/learning/filters.py
once again.Deadline
None
Other information
This PR depends on openedx/edx-lint#480 and #246
Checklists
Check off if complete or not applicable:
Merge Checklist:
Post Merge:
finished.