LuaLS / LuaLS/lua-language-server

Regular comments (i.e. `-- comment`) shouldn't be included in documentation

オープン
#2,764 コメント 19 件 リアクション 2 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

need discuss
主要言語
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
-- THIS IS NOT A DOC COMMENT
---This is a doc comment
local a = ''

Hovering a should show: This is a doc comment.

Actual Behaviour
-- 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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

issue の Lua 例から始め、NeoVim で hover の出力を再現します。通常の -- コメントが --- コメントと一緒に含まれる理由を特定するため、hover ドキュメントの処理を追跡します。a に hover したときに This is a doc comment だけが表示されれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
lua
領域
devtools
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。