LuaLS / LuaLS/lua-language-server
Automatic doc generation builds incorrectly assumingly large types as a return value
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 4.4k
- Forks
- 442
- PR merge metrics
- No merged PRs in 30d
Description
### 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
```lua
---comment
---@param value any
---@return "boolean"|"function"|"nil"|"number"|"string"|"table"|"userdata"|"thread"
local function myAwesomeFunction(value)
return type(value)
end
```
### Actual Behaviour
```lua
---comment
---@param value any
---@return "boolean"|"function"|"nil"|"number"|"string"...(+3)
local function myAwesomeFunction(value)
return type(value)
end
```
### Reproduction steps
Copy the code
```lua
---
local function myAwesomeFunction(value)
return type(value)
end
```
execute autocompletion from `---`.
### Additional Notes
Probably not a very important issue.
### Log File
_No response_
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the issue in the Visual Studio Code extension using the Lua example and trigger autocompletion from `---`. Compare the generated `---@return` annotation with the full union shown in the expected behavior; done means large return types are no longer abbreviated with `...(+3)`.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua, vscode
- Domain
- devtools
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100