openedx / openedx/code-annotations
Ensure only defined annotations are allowed
Ouverte
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 5
- Forks
- 13
- Merge moyen
- 18 h 26 min
- PR mergées (30 j)
- 4
Description
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
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par edx_lint/pylint/annotations_check.py autour de la ligne 291 pour comprendre le point d’entrée de linting existant. Consultez la discussion de l’issue #89 au sujet des commentaires entre les annotations, puis définissez comme critère de complétude l’émission d’un avertissement lorsqu’un nom d’annotation est indéfini ou mal orthographié, par exemple toggle_warnings au lieu de toggle_warning.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- tooling
- Type d'issue
- Fonctionnalité
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100