LuaLS / LuaLS/lua-language-server
Regular comments (i.e. `-- comment`) shouldn't be included in documentation
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?
NeoVim
### Which OS are you using?
MacOS
### What is the issue affecting?
Hover
### Expected Behaviour
```lua
-- THIS IS NOT A DOC COMMENT
---This is a doc comment
local a = ''
```
Hovering `a` should show: `This is a doc comment`.
### Actual Behaviour
```lua
-- THIS IS NOT A DOC COMMENT
local a = ''
```
Hovering `a` shows:
```
THIS IS NOT A DOC COMMENT
This is a doc comment
```
### Reproduction steps
See above ^^^
### Additional Notes
_No response_
### 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
Start with the Lua example in the issue and reproduce the hover output in NeoVim. Trace the hover documentation handling to determine why regular `--` comments are included alongside `---` comments; done means hovering `a` shows only `This is a doc comment`.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- devtools
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100