LuaLS / LuaLS/lua-language-server
@see annotaton duplicates documentation when using with @class
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?
Windows
What is the issue affecting?
Annotations
Expected Behaviour
I'm trying to add some @see tags to my @class
Actual Behaviour
When hovering class in editor, displayed documentation is printed twice.
Reproduction steps
Here is basic code sample. Hovering or typing class1 causes issue with displayed documentation
--- some class dock
---
---@class C2
local class2 = {}
--- another class dock here
---
---@see C2
---@class C1
local class1 = {}
---@type C1
local class1_instance = class1
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 bản tái hiện bằng Lua được cung cấp trong issue và so sánh kết quả hover cho C1 khi có và khi không có annotation @see C2. Không có tệp hoặc test nào trong repository được nêu tên, vì vậy hãy xác định phần xử lý annotation và tài liệu lớp được language server sử dụng, sau đó xác minh rằng tài liệu của C1 được hiển thị một lần trong khi tham chiếu @see vẫn khả dụ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
- devtools
- 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
- 48/100