LuaLS / LuaLS/lua-language-server

Automatic doc generation builds incorrectly assumingly large types as a return value

Đang mở
#1,617 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.

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ả

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, Completion

Expected Behaviour
---comment
---@param value any
---@return "boolean"|"function"|"nil"|"number"|"string"|"table"|"userdata"|"thread"
local function myAwesomeFunction(value)
	return type(value)
end
Actual Behaviour
---comment
---@param value any
---@return "boolean"|"function"|"nil"|"number"|"string"...(+3)
local function myAwesomeFunction(value)
	return type(value)
end
Reproduction steps

Copy the code

---
local function myAwesomeFunction(value)
	return type(value)
end

execute autocompletion from ---.

Additional Notes

Probably not a very important issue.

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

Tái hiện vấn đề trong tiện ích mở rộng Visual Studio Code bằng ví dụ Lua và kích hoạt tính năng tự động hoàn thành từ ---. So sánh chú thích ---@return được tạo với union đầy đủ được hiển thị trong hành vi mong đợi; hoàn thành khi các kiểu trả về lớn không còn được viết tắt bằng ...(+3).

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, vscode
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
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.