openedx / openedx/code-annotations
Ensure only defined annotations are allowed
Aperta
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 5
- Fork
- 13
- Merge medio
- 18h 26m
- PR unite (30g)
- 4
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia da edx_lint/pylint/annotations_check.py intorno alla riga 291 per comprendere l’entry point di linting esistente. Esamina la discussione dell’issue #89 sui commenti tra le annotazioni, quindi definisci come completamento l’emissione di un avviso quando un nome di annotazione non è definito o è scritto in modo errato, come toggle_warnings invece di toggle_warning.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100