LuaLS / LuaLS/lua-language-server

Automatic doc generation builds incorrectly assumingly large types as a return value

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

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

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

説明

How are you using the lua-language-server?

Visual Studio Code Extension (sumneko.lua)

Which OS are you using?

Windows

What is the issue affecting?

Annotations, Completion

Expected Behaviour
---comment
---@param value any
---@return "boolean"|"function"|"nil"|"number"|"string"|"table"|"userdata"|"thread"
local function myAwesomeFunction(value)
	return type(value)
end
Actual Behaviour
---comment
---@param value any
---@return "boolean"|"function"|"nil"|"number"|"string"...(+3)
local function myAwesomeFunction(value)
	return type(value)
end
Reproduction steps

Copy the code

---
local function myAwesomeFunction(value)
	return type(value)
end

execute autocompletion from ---.

Additional Notes

Probably not a very important issue.

Log File

No response

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

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

はじめの一歩

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

調査の方向性

Lua の例を使用して Visual Studio Code 拡張機能で問題を再現し、--- から自動補完を実行します。生成された ---@return アノテーションを、期待される動作で示される完全な union と比較します。大きな戻り値の型が ...(+3) で省略されなくなれば完了です。

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

評価

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

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

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