openedx / openedx/code-annotations
Remove ability to comment between annotations
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 5
- Forks
- 13
- Ø Merge
- 18 Std. 26 Min.
- Gemergte PRs (30 T.)
- 4
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit tests/extensions/python_test_files/multiline_singlelinecomment.pyt, das Kommentare zwischen Annotationen zeigt, und verfolge dann die von diesem Fixture ausgeübte Implementierung. Entferne die Unterstützung für diese Anordnung, aktualisiere die relevanten Erwartungen und überprüfe, dass das Parsen und Linting von Annotationen Kommentare zwischen Code-Annotationen nicht mehr akzeptieren.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- tooling
- Issue-Typ
- Refactoring
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100