openedx / openedx/code-annotations
Remove ability to comment between annotations
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5
- Forks
- 13
- Avg merge
- 18h 26m
- Merged PRs (30d)
- 4
Description
It has been discussed during toggles annotation work that the ability to intermix comments between code annotations doesn't seem to add much value, and instead adds implementation complexity and bugs.
See example test file for this use case:
https://github.com/openedx/code-annotations/blob/master/tests/extensions/python_test_files/multiline_singlelinecomment.pyt
See toggle annotation PR comment about potential issue with linting due to this issue: https://github.com/openedx/edx-platform/pull/27222#discussion_r606037209.
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 tests/extensions/python_test_files/multiline_singlelinecomment.pyt, which demonstrates comments interspersed between annotations, then trace the implementation exercised by that fixture. Remove support for this arrangement, update the relevant expectations, and verify that annotation parsing and linting no longer accept comments between code annotations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100