LuaLS / LuaLS/lua-language-server
Additional blank lines are added to parameter descriptions in type annotations
まだ誰も着手していません。
- 主要言語
- Lua
- スター
- 4.4k
- フォーク
- 442
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
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
- Create a
luafile with the following content:
---@param bar any This is the description
--- for bar.
local function foo(bar) end
- Hover over
foo. - Notice the broken highlighting/formatting in the description of
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
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
提供された Lua の例を使い、NeoVim または VS Code で foo にカーソルを合わせて問題を再現します。hover のレスポンスと複数行の @param の説明に対するフォーマット処理の経路から調査を始めます。両方の報告された環境で、Markdown の構文ハイライトを壊さずに説明が 1 行として表示されれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- lua
- 領域
- tooling
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 45/100