openedx / openedx/code-annotations
Remove ability to comment between annotations
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 5
- Forks
- 13
- Merge medio
- 18 h 26 min
- PR fusionados (30 d)
- 4
Descripción
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.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con tests/extensions/python_test_files/multiline_singlelinecomment.pyt, que demuestra comentarios intercalados entre anotaciones; después, sigue la implementación que ejercita ese fixture. Elimina la compatibilidad con esta disposición, actualiza las expectativas relevantes y verifica que el análisis y el linting de anotaciones ya no acepten comentarios entre anotaciones de código.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- tooling
- Tipo de issue
- Refactorización
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100