LuaLS / LuaLS/lua-language-server
feature request: markdown field support in aliases
Đang mở
Chưa có ai nhận issue này.
enhancement
- Ngôn ngữ chính
- Lua
- Star
- 4.4k
- Fork
- 442
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
Currently, when writing an alias such as:
---@alias fontmeta.alias.NameTableFormat
---| 0 # Always 0 for TrueType, OpenType accept it as well. See [OpenType Name Table Version 0](https://learn.microsoft.com/en-us/typography/opentype/spec/name#naming-table-version-0).
---| 1 # Can only be 1 for OpenType. See [OpenType Name Table Version 1](https://learn.microsoft.com/en-us/typography/opentype/spec/name#naming-table-version-1).
---| integer
The markdown of the description text (after the #) are not parsed as markdown:
Would be neat if the alias was parsed as multiple tags, similar to how it is done with arguments:
(the data argument)
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.
Hướng nghiên cứu
Issue không nêu tên các tệp hoặc bài kiểm thử. Hãy bắt đầu bằng cách lần theo quá trình phân tích cú pháp alias và so sánh với cách xử lý Markdown của đối số/dữ liệu hiện có được mô tả trong báo cáo; hoàn thành nghĩa là Markdown trong các mô tả alias được render nhất quán với các mô tả đối số.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- lua
- Lĩnh vực
- devtools
- Loại issue
- Tính năng
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- 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
- 42/100