LuaLS / LuaLS/lua-language-server
Documentation doesn't contain the descriptions of classes.
Abierto
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?
Linux
What is the issue affecting?
Other
Expected Behaviour
Example input:
Expecting output like:
#Action
<fields & methods>
Actual Behaviour
Example output:
Here's what I see when mousing over it in VSCode:
Reproduction steps
Build docs using LuaLSP's CLI, see that descriptions get stripped/not output.
Additional Notes
No response
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
Empieza con la ruta de LuaLS CLI que genera la documentación y reproduce el problema utilizando el ejemplo documentado. Compara la salida generada con la descripción esperada de la clase, los campos y los métodos; se considera terminado cuando las descripciones se conservan en la documentación generada.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- lua
- Área
- documentation
- 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