LuaLS / LuaLS/lua-language-server
Can't export documentation for functions
Abierto
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
I created a file with this content:
-- Test comment.
---@param x number
---@return number
return function(x)
return x*2
end
Then I tried to export documentation from that file following this instruction, but got empty files in the output.
Classes are exported successfully, but how to export functions I do not understand.
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
Comienza con la instrucción de la wiki Export Documentation y reproduce el problema usando el ejemplo de Lua del informe. Compara el caso de la función con el caso de la clase exportada correctamente y determina por qué los archivos de salida están vacíos; se considera terminado cuando las funciones documentadas producen una salida exportada no vacía.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- lua
- Área
- documentation, tooling
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 38/100