LuaLS / LuaLS/lua-language-server
`--doc` writes lua's documentation instead of given module's
Đang mở
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ả
How are you using the lua-language-server?
Command Line
Which OS are you using?
Windows WSL
What is the issue affecting?
Other
Expected Behaviour
Producing documentation for the given module
Actual Behaviour
Producing documentation for lua's builtin functions
Reproduction steps
- Create & cd into empty folder with a module.lua inside:
---@param x number
function foo(x) end
- Execute
lua-language-server --doc=. --doc_out_path=. - Get the doc.md & doc.json containing lua docs instead of module docs
Additional Notes
Tested on 3.13.5.
Log File
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 lệnh lua-language-server --doc và theo dõi cách --doc=. và --doc_out_path=. chọn module đầu vào và các tệp đầu ra. Tái hiện sự cố bằng module.lua được cung cấp, sau đó xác minh rằng doc.md và doc.json mô tả module đó thay vì các hàm tích hợp sẵn của Lua.
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
- cli, documentation
- 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
- 35/100