Ensure proper toggle annotations are used.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
Ensure undefined annotations are not allowed. For example, if toggle_warnings were used instead of toggle_warning, linting should complain.
Without this, the annotation would be visible in code, but it wouldn’t make it to readthedocs and you wouldn’t know it without checking explicitly.
This would likely be fixed by working on https://github.com/openedx/code-annotations/issues/91.
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 the linked code-annotations issue #91 and inspect how edx-toggles annotations are currently processed. Verify how an undefined annotation such as toggle_warnings should be reported during linting, and confirm that valid annotations still appear in Read the Docs output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100