LuaLS / LuaLS/lua-language-server
@see annotaton duplicates documentation when using with @class
オープン
まだ誰も着手していません。
- 主要言語
- 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
Expected Behaviour
I'm trying to add some @see tags to my @class
Actual Behaviour
When hovering class in editor, displayed documentation is printed twice.
Reproduction steps
Here is basic code sample. Hovering or typing class1 causes issue with displayed documentation
--- some class dock
---
---@class C2
local class2 = {}
--- another class dock here
---
---@see C2
---@class C1
local class1 = {}
---@type C1
local class1_instance = class1
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Issue に提供されている Lua の再現例から始め、@see C2 アノテーションの有無による C1 のホバー結果を比較します。リポジトリのファイルやテストは指定されていないため、language server で使用されているアノテーションとクラスドキュメントの処理箇所を特定し、C1 のドキュメントが 1 回だけ表示され、@see リファレンスが引き続き利用可能であることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- lua
- 領域
- devtools
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 48/100