openedx / openedx/code-annotations
Remove ability to comment between annotations
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 5
- Fork
- 13
- Merge medio
- 18h 26m
- PR unite (30g)
- 4
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia da tests/extensions/python_test_files/multiline_singlelinecomment.pyt, che mostra commenti intercalati tra le annotazioni, quindi segui l’implementazione esercitata da quel fixture. Rimuovi il supporto per questa disposizione, aggiorna le aspettative pertinenti e verifica che il parsing e il linting delle annotazioni non accettino più commenti tra le annotazioni del codice.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- tooling
- Tipo di issue
- Refactoring
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100