MagicStack / MagicStack/MagicPython

Highlight all PEP-0350 defined codetags

Aberta
#250 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Linguagem predominante
JavaScript
Estrelas
1.4k
Forks
98
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

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: 
"""

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece localizando as definições existentes de realce de codetag do MagicPython e compare-as com a lista de mnemônicos do PEP-0350 no issue. Estenda a lista reconhecida para abranger os mnemônicos de nível superior solicitados e, em seguida, execute os testes de realce de sintaxe do projeto ou inspecione comentários Python realçados para verificar as novas tags.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
javascript
Domínio
tooling
Tipo de issue
Funcionalidade
Dificuldade
2/5
Tempo estimado
1-3 horas
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
45/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.