LuaLS / LuaLS/lua-language-server
It is better to have multiline for annote the @overload
Open
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
Expected Behaviour
--- @overload fun(
--- x:number,
--- y:number,
--- width:number,
--- height:number
--- ):Object
Actual Behaviour
--- @overload fun( x:number, y:number, width:number, height:number ):Object
Reproduction steps
- Go to '...'
- Click '...'
- See error '...'
Additional Notes
Please adding this feature because some of my annotation is really really long.
Writing in one line makes unreadable and ugly.
Thanks much!
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 annotation behavior in the Visual Studio Code extension using the multiline and single-line @overload examples from the issue. Start by tracing how Lua annotations are parsed, then verify that multiline overload signatures are accepted and remain readable without breaking existing annotations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua, vscode
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100