LuaLS / LuaLS/lua-language-server

Documentation doesn't contain the descriptions of classes.

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

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

主要言語
Lua
スター
4.4k
フォーク
442
PR マージ指標
30日以内にマージされた PR はありません

説明

How are you using the lua-language-server?

Visual Studio Code Extension (sumneko.lua)

Which OS are you using?

Linux

What is the issue affecting?

Other

Expected Behaviour

Example input:

Image

Expecting output like:

#Action

<fields & methods>

Actual Behaviour

Example output:

Image

Here's what I see when mousing over it in VSCode:

Image

Reproduction steps

Build docs using LuaLSP's CLI, see that descriptions get stripped/not output.

Additional Notes

No response

Log File

No response

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

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

はじめの一歩

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

調査の方向性

ドキュメントを生成する LuaLS CLI のパスから始め、ドキュメント化された例を使って問題を再現します。生成された出力を、期待されるクラスの説明、フィールド、メソッドと比較します。生成されたドキュメントに説明が保持されていれば完了です。

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

評価

技術スタック
lua
領域
documentation
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

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

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