LuaLS / LuaLS/lua-language-server
Operators are not included in the output when generating documentation via the --doc CLI argument
まだ誰も着手していません。
- 主要言語
- Lua
- スター
- 4.4k
- フォーク
- 442
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
How are you using the lua-language-server?
Command Line
Which OS are you using?
Linux
What is the issue affecting?
Annotations, Other
Expected Behaviour
When generating markdown and JSON documentation via the command line argument --doc, the output files should contain operators defined by the @operator syntax.
Actual Behaviour
The expected behavior is that the operators are missing in both the markdown and JSON generated files.
Reproduction steps
Given the following Lua file:
---@meta
---@class Vector2f
---@operator unm:Vector2f
---@operator add(Vector2f | number):Vector2f
---@operator sub(Vector2f | number):Vector2f
Vector2f = {}
When the language server is run with the following args:
./LuaS/bin/lua-language-server --doc=./example.lua --doc_out_path=.
Then the output doc.md and doc.json do not contain any of the operators specified.
In the doc.json the type Vector2d is the following, notice the lack of any operators:
{
"defines": [
{
"async": false,
"deprecated": false,
"file": ".",
"finish": [
2,
18
],
"start": [
2,
10
],
"type": "doc.class",
"view": "Vector2f",
"visible": "public"
}
],
"fields": [],
"name": "Vector2f",
"type": "type",
"view": "Vector2f"
}
Additional Notes
No response
Log File
No response
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
--doc CLIエントリポイントから開始し、example.luaの入力がdoc.mdとdoc.jsonに変換される流れを追ってください。提供されたVector2fの例で問題を再現し、その後、生成された両方のファイルに@operatorの定義が含まれていることを確認してください。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- lua
- 領域
- cli, documentation
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100