Improve readability of annotation syntaxes
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 25/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Cần làm rõ
- Mức độ hoạt động
- Đình trệ
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu với trang annotations/#understanding-this-page được liên kết và xem lại các ví dụ về cú pháp phức tạp được nêu trong issue. Issue không xác định cách thay thế được ưu tiên cũng như một bài kiểm tra hoàn thành rõ ràng; để hoàn tất, cần thống nhất một ký hiệu dễ đọc hơn và cập nhật các ví dụ trong tài liệu.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
The method currently used for describing how to use annotations can be easy to understand at times:
---@type <type>
And also impossible for mere mortals to understand:
---@cast <value_name> [+|-]<type|?>[, [+|-]<type|?>...]
---@overload fun([param: type[, param: type...]]): [return_value[,return_value]]
There must be a better way to represent these more complex syntaxes while also not using symbols regularly in use (<, >, (, ), [, ], {, }, @, #, -, +, =, :, ", ,, ., ?). Although now that I have listed some in-use symbols, I realize we really are quite limited. It is hard to explain a syntax that uses many symbols… using symbols.
I'm open to any suggestions on how this can be improved 🙂
- Ngôn ngữ chính
- MDX
- Star
- 10
- Fork
- 19
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue tương tự
-
Ecosystem: ClawMetry — the Qwen Code reader is now free and open source (follow-up to #9294 / #9338) Đang mởcategory/integration priority/P3 scope/documentation status/ready-for-human type/feature-request
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 84/100
-
docs(agents): strengthen the no-backslash-escaped-backticks rule with an issue-creation example Đang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 92/100
-
documentation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
-
fix: inaccuracy ⚠️
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
uabrc/uabrc.github.io#1255 · 1 bình luận ·
-
Improve Menu Type example Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100