Skip to content

Highlight all PEP-0350 defined codetags #250

@samamorgan

Description

@samamorgan

MagicPython currently only highlights a very small subset of the codetags from 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:
    image
  • 5-10 lines of surrounding code: Exhaustive list of mnemonics:
"""
## 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: 
"""

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions