LuaLS / LuaLS/lua-language-server

@alias comments aren't visible

Abierto
#1,627 1 comentario 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

enhancement
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?

Linux

What is the issue affecting?

Annotations, Hover

Expected Behaviour

a comment to an alias type should be shown as regular comment to a parameter would be shown (at least if there is no comment to the @param annotation itself). The hover message should read:

function f(arg: string)
@param arg — comment from alias

Unused functions.Lua Diagnostics.(unused-function)
Unused local `f`.Lua Diagnostics.(unused-local)
Actual Behaviour

the comment to the alias type isn't shown. the hover message is:

function f(arg: string)
Unused functions.Lua Diagnostics.(unused-function)
Unused local `f`.Lua Diagnostics.(unused-local)
Reproduction steps
  1. cat << EOF > file.lua
    ---@alias t_arg string comment from alias
    ---@param arg t_arg
    local function f(arg)
    end
    EOF
  2. code file.lua
  3. hover over the function name and read message

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

Reproduce el problema en file.lua usando las anotaciones @alias y @param mostradas y, después, inspecciona el punto de entrada del hover para la documentación de funciones. Se considera terminado cuando al pasar el cursor sobre f se incluye el comentario del alias como @param arg, se conservan los diagnósticos existentes y se respeta cualquier comentario @param explícito.

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
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.