LuaLS / LuaLS/lua-language-server
Automatic doc generation builds incorrectly assumingly large types as a return value
未关闭
还没有人认领这个 Issue。
enhancement
- 主要语言
- Lua
- 星标
- 4.4k
- 派生
- 442
- PR 合并指标
- 30 天内没有已合并 PR
描述
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
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
使用 Lua 示例在 Visual Studio Code 扩展中重现该问题,并从 --- 触发自动补全。将生成的 ---@return 注释与预期行为中显示的完整 union 进行比较;当较大的返回类型不再使用 ...(+3) 缩写时,即表示完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- lua, vscode
- 领域
- devtools
- Issue 类型
- 缺陷
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100