openedx / openedx/code-annotations
Ensure only defined annotations are allowed
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5
- Forks
- 13
- Avg merge
- 18h 26m
- Merged PRs (30d)
- 4
Description
At this time, users are not given any linting warnings when undefined annotations are used, including misspellings.
Additional Notes:
- An example: someone might use
toggle_warningsinstead oftoggle_warning. - It has been noted that removing the ability to comment between annotations (see https://github.com/openedx/code-annotations/issues/89) would make this simpler to implement.
- Linting might be implemented here: https://github.com/openedx/edx-lint/blob/7573005f89df7f78142a2af86673206e8b43c4d5/edx_lint/pylint/annotations_check.py#L291
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with edx_lint/pylint/annotations_check.py around line 291 to understand the existing linting entry point. Review issue #89's discussion about comments between annotations, then define done as emitting a warning when an annotation name is undefined or misspelled, such as toggle_warnings instead of toggle_warning.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100