LuaLS / LuaLS/lua-language-server

@see annotation surrounds unknown symbols with tilde "~" (strikethrough)

Open
#2,889 8 comments 0 reactions 0 assignees View on GitHub
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?

Nvim

### Which OS are you using?

MacOS

### What is the issue affecting?

Hover

### Expected Behaviour

code should be able to use `@see` annotations that don't necessarily map to a known symbol.

### Actual Behaviour

unknown symbols are rendered as "strikethrough": https://github.com/LuaLS/lua-language-server/blob/8c32d8f95f28f8bc064533031898abfb7dea58b0/script/core/hover/description.lua#L144

### Reproduction steps

1. add a `@see bogus` annotation
2. hover the annotation in any LSP client

### Additional Notes

_No response_

### Log File

_No response_

Contributor guide

Open the contributing guide

Research direction

Start at script/core/hover/description.lua around line 144, then reproduce the issue with an @see bogus annotation and hover it in an LSP client. Confirm the handling of an unresolved @see symbol and verify that the completed behavior no longer renders the unknown symbol with strikethrough.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
devtools
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.