LuaLS / LuaLS/lua-language-server

@see annotaton duplicates documentation when using with @class

Open
#2,570 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lua
Stars
4.4k
Forks
442
PR merge metrics
No merged PRs in 30d

Description

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.
image

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the provided Lua reproduction in the issue and compare hover results for C1 with and without the @see C2 annotation. No repository file or test is named, so locate the annotation and class-documentation handling used by the language server, then verify that C1's documentation is displayed once while the @see reference remains available.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.