LuaLS / LuaLS/lua-language-server
`@param` fails to include multiline description
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 WSL
What is the issue affecting?
Annotations
Expected Behaviour
Attributes should be correctly parsed when they wrap over multiple lines.
Actual Behaviour
In VSCode:
---@param foo integer This is a long description that wrongs over multiple lines
---but is misinterpreted.
function x(foo) end
---@param foo integer
---
---Long description with multiple paragraphs, and a code example:
---
---Usage:
---```lua
---local result = x(5)
---```
function x(foo) end
Reproduction steps
Paste code above into VSCode.
Additional Notes
Surely it should be possible to write more than a single line of description for a parameter (and other tags).
Log File
No response
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Reproduce el comportamiento en la extensión de VSCode usando los fragmentos de Lua del informe y, después, sigue la ruta de análisis de anotaciones para las descripciones multilínea de @param. El trabajo se considera terminado cuando el texto ajustado, los saltos de párrafo y el ejemplo de código mostrado se conservan correctamente. El informe no menciona ningún archivo fuente ni ninguna prueba, por lo que localizar el parser y las pruebas de anotaciones existentes forma parte del trabajo.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- lua, vscode
- Á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