LuaLS / LuaLS/lua-language-server

Documentation doesn't contain the descriptions of classes.

未關閉
#3,138 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

主要語言
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. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

從建置文件的 LuaLS CLI 路徑開始,並使用文件中的範例重現該問題。將產生的輸出與預期的類別描述、欄位和方法進行比較;當描述保留在產生的文件中時,即表示完成。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
lua
領域
documentation
Issue 類型
缺陷
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。