LuaLS / LuaLS/lua-language-server

`--doc` writes lua's documentation instead of given module's

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

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

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

説明

How are you using the lua-language-server?

Command Line

Which OS are you using?

Windows WSL

What is the issue affecting?

Other

Expected Behaviour

Producing documentation for the given module

Actual Behaviour

Producing documentation for lua's builtin functions

Reproduction steps
  1. Create & cd into empty folder with a module.lua inside:
---@param x number
function foo(x) end
  1. Execute lua-language-server --doc=. --doc_out_path=.
  2. Get the doc.md & doc.json containing lua docs instead of module docs
Additional Notes

Tested on 3.13.5.

Log File

file_home_girvel_tmp_..log
service.log

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

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

はじめの一歩

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

調査の方向性

lua-language-server --doc コマンドから始め、--doc=.--doc_out_path=. が入力モジュールと出力ファイルをどのように選択するかを追跡します。提供された module.lua で問題を再現し、その後、doc.mddoc.json が Lua の組み込み関数ではなく、そのモジュールを記述していることを確認します。

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

評価

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

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

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