LuaLS / LuaLS/lua-language-server
Can't export documentation for functions
Đ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ả
I created a file with this content:
-- Test comment.
---@param x number
---@return number
return function(x)
return x*2
end
Then I tried to export documentation from that file following this instruction, but got empty files in the output.
Classes are exported successfully, but how to export functions I do not understand.
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 với hướng dẫn trên wiki Export Documentation và tái hiện vấn đề bằng ví dụ Lua trong báo cáo. So sánh trường hợp hàm với trường hợp lớp được export thành công và xác định tại sao các tệp đầu ra lại trống; công việc được xem là hoàn tất khi các hàm được ghi tài liệu tạo ra đầu ra export không rỗng.
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, tooling
- Loại issue
- Lỗi
- Độ 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
- 38/100