LuaLS / LuaLS/lua-language-server

[Feature Request] Add additional fields to exported docs

未关闭
#2,416 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Lua
星标
4.4k
派生
442
PR 合并指标
30 天内没有已合并 PR

描述

Right now, it's very difficult to parse the exported docs. I've mostly been able to figure stuff out, but there's a bit of information the exported JSON file does not expose, which I would like to suggest.

  • A field for which class something originates from, to filter out unchanged methods/fields from parents
  • A relative version of file, instead of an absolute path
  • A version of the description which does not include markdown for params and return values, since those are separate
  • Whether a function is deprecated or not
  • A way to hide a field or method from the docs export (---@nodoc?)
  • Maybe a way to not export inherited fields/methods? The exported file for my project is more than a million lines long...

贡献指南

打开贡献指南

从这里开始

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

调研方向

首先定位导出的文档 JSON 实现,以及为函数、方法和字段组装字段的代码。检查当前如何表示继承、文件路径、描述和弃用;完成标准是确定一致同意的范围,并添加覆盖所选导出字段以及 nodoc 或继承行为的测试。

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

评估

技术栈
lua
领域
documentation
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
25/100

把新 issue 发到你的邮箱

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