openedx / openedx/code-annotations
Ensure only defined annotations are allowed
Offen
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 5
- Forks
- 13
- Ø Merge
- 18 Std. 26 Min.
- Gemergte PRs (30 T.)
- 4
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginnen Sie mit edx_lint/pylint/annotations_check.py um Zeile 291, um den bestehenden Linting-Einstiegspunkt zu verstehen. Sehen Sie sich die Diskussion zu Issue #89 über Kommentare zwischen Annotationen an und legen Sie dann als Abschlusskriterium fest, dass eine Warnung ausgegeben wird, wenn ein Annotationsname nicht definiert oder falsch geschrieben ist, beispielsweise toggle_warnings statt toggle_warning.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100