LuaLS / LuaLS/lua-language-server
`--doc` writes lua's documentation instead of given module's
未关闭
还没有人认领这个 Issue。
- 主要语言
- Lua
- 星标
- 4.4k
- 派生
- 442
- PR 合并指标
- 30 天内没有已合并 PR
描述
How are you using the lua-language-server?
Command Line
Which OS are you using?
Windows WSL
What is the issue affecting?
Other
Expected Behaviour
Producing documentation for the given module
Actual Behaviour
Producing documentation for lua's builtin functions
Reproduction steps
- Create & cd into empty folder with a module.lua inside:
---@param x number
function foo(x) end
- Execute
lua-language-server --doc=. --doc_out_path=. - Get the doc.md & doc.json containing lua docs instead of module docs
Additional Notes
Tested on 3.13.5.
Log File
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从 lua-language-server --doc 命令开始,追踪 --doc=. 和 --doc_out_path=. 如何选择输入模块和输出文件。使用提供的 module.lua 重现该问题,然后验证 doc.md 和 doc.json 描述的是该模块,而不是 Lua 的内置函数。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- lua
- 领域
- cli, documentation
- Issue 类型
- 缺陷
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100