LuaLS / LuaLS/lua-language-server

Can't export documentation for functions

オープン
#2,015 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

enhancement
主要言語
Lua
スター
4.4k
フォーク
442
30日以内にマージされた PR はありません

説明

I created a file with this content:

-- Test comment.
---@param x number
---@return number
return function(x)
  return x*2
end

Then I tried to export documentation from that file following this instruction, but got empty files in the output.

Classes are exported successfully, but how to export functions I do not understand.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

Export Documentation wikiの指示から始め、報告書のLua例を使って問題を再現してください。関数の場合と正常にエクスポートされたクラスの場合を比較し、出力ファイルが空になる理由を特定してください。完了の条件は、ドキュメント化された関数が空でないエクスポート出力を生成することです。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
lua
領域
documentation, tooling
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
38/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。