LuaLS / LuaLS/lua-language-server

`--doc` writes lua's documentation instead of given module's

未关闭
#3,002 5 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 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
  1. Create & cd into empty folder with a module.lua inside:
---@param x number
function foo(x) end
  1. Execute lua-language-server --doc=. --doc_out_path=.
  2. Get the doc.md & doc.json containing lua docs instead of module docs
Additional Notes

Tested on 3.13.5.

Log File

file_home_girvel_tmp_..log
service.log

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

lua-language-server --doc 命令开始,追踪 --doc=.--doc_out_path=. 如何选择输入模块和输出文件。使用提供的 module.lua 重现该问题,然后验证 doc.mddoc.json 描述的是该模块,而不是 Lua 的内置函数。

由索引模型根据 Issue 内容生成。

评估

技术栈
lua
领域
cli, documentation
Issue 类型
缺陷
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。