Open MariaSolOs opened 1 year ago
This is mostly like because Lua-LS or LuaCATS can't recognize multi-line string for @param
. When hovered on the parameter bar
, the docstring for the parameter will be "This is the description" (without foo bar
).
It'd be great if multi-line strings can be supported for @param
desc -- because in some cases the description can be quite long. @sumneko Would this be possible?
How are you using the lua-language-server?
NeoVim
Which OS are you using?
MacOS
What is the issue affecting?
Hover
Expected Behaviour
For multiline descriptions in
@param
annotations to be displayed as if they were in a single line.Actual Behaviour
When the description in a
@param
annotation spans multiple lines, a linebreak in inserted in the Markdown response, which breaks syntax highlighting:Even after removing the preceding whitespace in the example above, formatting is still off:
Reproduction steps
lua
file with the following content:foo
.bar
.Additional Notes
Although VS Code doesn't have additional syntax highlighting, do note how the font style in
explanation above)
changes, which suggests that the issue is reproducible outside Neovim:Log File
No response