LuaLS / LuaLS/lua-language-server
[Feature Request] Add additional fields to exported docs
還沒有人認領這個 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
- [x] 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...
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
先找到匯出的文件 JSON 實作,以及為函式、方法和欄位組合欄位的程式碼。檢視目前如何表示繼承、檔案路徑、描述和棄用;完成的條件是確定一致同意的範圍,並加入涵蓋所選匯出欄位以及 nodoc 或繼承行為的測試。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- lua
- 領域
- documentation
- Issue 類型
- 功能
- 難度
- 5/5
- 預估耗時
- 一週以上
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 25/100