MagicStack / MagicStack/MagicPython

Highlight all PEP-0350 defined codetags

Ouverte
#250 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
JavaScript
Étoiles
1.4k
Forks
98
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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**:
![image](https://user-images.githubusercontent.com/356814/166968279-0c4717ec-722a-4858-9cee-2c0111582ac0.png)
* **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:
"""
```

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par localiser les définitions existantes de mise en évidence des codetag de MagicPython et comparez-les avec la liste de mnémoniques de PEP-0350 dans l’issue. Étendez la liste reconnue pour couvrir les mnémoniques de premier niveau demandés, puis exécutez les tests de coloration syntaxique du projet ou inspectez des commentaires Python mis en évidence afin de vérifier les nouvelles balises.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript
Domaine
tooling
Type d'issue
Fonctionnalité
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.