LuaLS / LuaLS/lua-language-server

@see annotaton duplicates documentation when using with @class

Ouverte
#2,570 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Lua
Étoiles
4.4k
Forks
442
Métriques de merge des PR
Aucune PR mergée en 30 j

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](https://github.com/LuaLS/lua-language-server/assets/75124358/6ab99d16-3b1c-420d-80ef-5b4ce43f8a85)

### Reproduction steps

Here is basic code sample. Hovering or typing `class1` causes issue with displayed documentation
```lua
--- some class dock
---
---@class C2
local class2 = {}

--- another class dock here
---
---@see C2
---@class C1
local class1 = {}

---@type C1
local class1_instance = class1
```

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la reproduction Lua fournie dans l’issue et comparez les résultats du survol pour C1 avec et sans l’annotation @see C2. Aucun fichier ni test du dépôt n’étant nommé, localisez la gestion des annotations et de la documentation des classes utilisée par le language server, puis vérifiez que la documentation de C1 est affichée une seule fois tandis que la référence @see reste disponible.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
lua
Domaine
devtools
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
48/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.