LuaLS / LuaLS/lua-language-server

Documentation doesn't contain the descriptions of classes.

Đang mở
#3,138 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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?

Visual Studio Code Extension (sumneko.lua)

Which OS are you using?

Linux

What is the issue affecting?

Other

Expected Behaviour

Example input:

Image

Expecting output like:

#Action

<fields & methods>

Actual Behaviour

Example output:

Image

Here's what I see when mousing over it in VSCode:

Image

Reproduction steps

Build docs using LuaLSP's CLI, see that descriptions get stripped/not output.

Additional Notes

No response

Log File

No response

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu với đường dẫn LuaLS CLI tạo tài liệu và tái hiện vấn đề bằng ví dụ đã được ghi trong tài liệu. So sánh đầu ra được tạo với mô tả lớp, các trường và các phương thức như mong đợi; hoàn tất khi các mô tả được giữ lại trong tài liệu được tạo.

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
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
45/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.