MagicStack / MagicStack/MagicPython
Highlight all PEP-0350 defined codetags
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 1.4k
- Forks
- 98
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
MagicPython currently only highlights a very small subset of the codetags from [PEP-0350](https://peps.python.org/pep-0350/):
- NOTE: A note
- XXX: Attention
- HACK: A hack
- FIXME: Problematic code
- BUG: A bug
- TODO: Pending task
I think the full list should be included in MagicPython, or at least the rest of the top-level mnemonics:
- NOBUG
- REQ
- RFE
- IDEA
- ???
- !!!
- PORT
- CAVEAT
- FAQ
- GLOSS
- SEE
- TODOC
- CRED
- STAT
- RVD
* **Editor name and version**: Visual Studio Code v1.66.2
* **Platform**: Windows 10.0.19044
* **Color scheme**: Dracula
* **MagicPython version**: 1.1.0
* **A sreenshot**:

* **5-10 lines of surrounding code**: Exhaustive list of mnemonics:
```python
"""
## Supported:
NOTE: A note
XXX: Attention
HACK: A hack
FIXME: Problematic code
BUG: A bug
TODO: Pending task
## Not supported:
MILESTONE:
MLSTN:
DONE:
YAGNI:
TBD:
TOBEDONE:
DEBUG:
BROKEN:
REFACTOR:
REFACT:
RFCTR:
OOPS:
SMELL:
NEEDSWORK:
INSPECT:
BUGFIX:
NOBUG:
NOFIX:
WONTFIX:
DONTFIX:
NEVERFIX:
UNFIXABLE:
CANTFIX:
REQ:
REQUIREMENT:
STORY:
RFE:
FEETCH:
NYI:
FR:
FTRQ:
FTR:
IDEA:
???:
QUESTION:
QUEST:
QSTN:
WTF:
!!!:
ALERT:
CLEVER:
MAGIC:
PORT:
PORTABILITY:
WKRD:
CAVEAT:
CAV:
CAVT:
WARNING:
CAUTION:
HELP:
FAQ:
GLOSS:
GLOSSARY:
SEE:
REF:
REFERENCE:
TODOC:
DOCDO:
DODOC:
NEEDSDOC:
EXPLAIN:
DOCUMENT:
CRED:
CREDIT:
THANKS:
STAT:
STATUS:
RVD:
REVIEWED:
REVIEW:
"""
```
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
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
Beginne damit, MagicPythons bestehende Definitionen für die Codetag-Hervorhebung zu finden und sie mit der PEP-0350-Mnemonikliste im Issue zu vergleichen. Erweitere die Liste der erkannten Einträge, sodass sie die angeforderten Top-Level-Mnemonics abdeckt, und führe anschließend die Syntax-Highlighting-Tests des Projekts aus oder prüfe hervorgehobene Python-Kommentare, um die neuen Tags zu verifizieren.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript
- Bereich
- tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100