openedx / openedx/code-annotations
Remove ability to comment between annotations
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
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.
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 tests/extensions/python_test_files/multiline_singlelinecomment.pyt, qui montre des commentaires intercalés entre des annotations, puis suivez l’implémentation exercée par ce fixture. Supprimez la prise en charge de cette disposition, mettez à jour les attentes concernées et vérifiez que l’analyse et le linting des annotations n’acceptent plus les commentaires entre les annotations de code.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- tooling
- Type d'issue
- Refactorisation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100