LuaLS / LuaLS/lua-language-server
Request for ability to skip adding to documentation, i.e. `---@nodoc`
オープン
まだ誰も着手していません。
question
- 主要言語
- Lua
- スター
- 4.4k
- フォーク
- 442
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
At the moment, if I do anything that references _G, all of the documentation for _G populates the documentation. It would be nice to be able to prevent superfluous documentation - especially for stuff that's only local to the file and not exported for public use.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、ファイルが _G を参照している場合にドキュメントがどのように収集されるかを追跡し、次に ---@nodoc マーカーを認識できる箇所を特定します。完了条件は、公開シンボルのドキュメントを削除せずに、ローカルシンボルやその他の非公開シンボルを生成されたドキュメントから除外できることです。この issue ではファイルやテストが指定されていないため、まずそれらのエントリーポイントを見つける必要があります。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- lua
- 領域
- documentation
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100