LuaLS / LuaLS/lua-language-server
[Feature Request] Add additional fields to exported docs
オープン
まだ誰も着手していません。
- 主要言語
- 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...
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、エクスポートされるドキュメント JSON の実装と、関数、メソッド、フィールドのフィールドを組み立てるコードを特定します。継承、ファイルパス、説明、非推奨が現在どのように表現されているかを確認します。選択したエクスポートフィールドと nodoc または継承の動作を対象とする、合意されたスコープとテストが整えば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- lua
- 領域
- documentation
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 25/100