LuaLS / LuaLS/lua-language-server
[Feature Request] Add additional fields to exported docs
Chưa có ai nhận issue này.
- 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ả
Right now, it's very difficult to parse the exported docs. I've mostly been able to figure stuff out, but there's a bit of information the exported JSON file does not expose, which I would like to suggest.
- A field for which class something originates from, to filter out unchanged methods/fields from parents
- A relative version of
file, instead of an absolute path - A version of the description which does not include markdown for params and return values, since those are separate
- Whether a function is deprecated or not
- A way to hide a field or method from the docs export (
---@nodoc?) - Maybe a way to not export inherited fields/methods? The exported file for my project is more than a million lines long...
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
Bắt đầu bằng cách xác định phần triển khai JSON tài liệu được export và mã tập hợp các trường cho hàm, phương thức và trường. Xem xét cách tính kế thừa, đường dẫn tệp, mô tả và trạng thái không còn được khuyến nghị hiện đang được biểu diễn; công việc được xem là hoàn tất khi có phạm vi đã thống nhất và các bài kiểm thử bao quát những trường export được chọn cũng như hành vi của nodoc hoặc tính kế thừa.
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
- documentation
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- 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
- 25/100