openedx / openedx/code-annotations
Ensure only defined annotations are allowed
Abierto
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
At this time, users are not given any linting warnings when undefined annotations are used, including misspellings.
Additional Notes:
- An example: someone might use
toggle_warningsinstead oftoggle_warning. - It has been noted that removing the ability to comment between annotations (see https://github.com/openedx/code-annotations/issues/89) would make this simpler to implement.
- Linting might be implemented here: https://github.com/openedx/edx-lint/blob/7573005f89df7f78142a2af86673206e8b43c4d5/edx_lint/pylint/annotations_check.py#L291
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 edx_lint/pylint/annotations_check.py alrededor de la línea 291 para entender el punto de entrada de linting existente. Revisa la discusión del issue #89 sobre los comentarios entre anotaciones y, después, define como completado que se emita una advertencia cuando un nombre de anotación no esté definido o esté mal escrito, como toggle_warnings en lugar de toggle_warning.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100