-
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: MJG/enrich-descriptions
Are you sure you want to change the base?
feat: [FC-0074] use linter for openedx-filters classes definitions #249
Conversation
Thanks for the pull request, @mariajgrimaldi! What's next?Please work through the following steps to get your changes ready for engineering review: 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. 🔘 Let us know that your PR is ready for review:Who will review my changes?This repository is currently maintained by Where can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:
When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
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.