MagicStack / MagicStack/MagicPython

Highlight all PEP-0350 defined codetags

Đang mở
#250 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Ngôn ngữ chính
JavaScript
Star
1.4k
Fork
98
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

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

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng cách tìm các định nghĩa hiện có về tô sáng codetag của MagicPython và so sánh chúng với danh sách mnemonic trong PEP-0350 ở issue. Mở rộng danh sách được nhận diện để bao quát các mnemonic cấp cao nhất được yêu cầu, sau đó chạy các bài kiểm thử tô sáng cú pháp của dự án hoặc kiểm tra các chú thích Python đã được tô sáng để xác minh các tag mới.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
javascript
Lĩnh vực
tooling
Loại issue
Tính năng
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
45/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.