LuaLS / LuaLS/lua-language-server

@see annotaton duplicates documentation when using with @class

Abierto
#2,570 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Lua
Estrellas
4.4k
Forks
442
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con la reproducción en Lua proporcionada en el issue y compara los resultados de hover para C1 con y sin la anotación @see C2. No se nombra ningún archivo ni prueba del repositorio, así que localiza el manejo de anotaciones y documentación de clases utilizado por el language server y verifica que la documentación de C1 se muestre una vez, mientras la referencia @see siga estando disponible.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
lua
Área
devtools
Tipo de issue
Error
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
48/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.