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 摘要。