LuaLS / LuaLS/lua-language-server
Documentation export is missing information
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?
Command Line
Which OS are you using?
Windows
What is the issue affecting?
Other
Expected Behaviour
After generating documentation with --doc, I expected to have access to the all of the information available in the annotations that is presented or used by the language server.
Actual Behaviour
There were a few things that are missing or strange:
@seeannotations are absent.- Access levels (
@protected,@private,@package) are absent. - Aliases that extend other aliases include the documentation of the alias that they extend, which makes it difficult to tell which documentation belongs to only the extended alias.
- The
startandfinishfields seem odd; they're very large numbers (e.g., 5490009, 5490021) that clearly don't refer to character ranges within the files. What are these numbers?
For the purpose of generating documentation, the first two problems seem significant—it would be difficult to filter out private fields and methods, for example.
Reproduction steps
- Create a Lua file that uses access modifiers,
@see, and an alias that extends another alias. I've provided a minimal example of such a file below. - Observe the missing data and oddities.
Additional Notes
Example for reproduction:
---@class C
---@field private z integer
local C = {}
---Base alias doc comment.
---@alias Base
---| 'A'
---| 'B'
---Extended alias doc comment.
---@alias Derived
---| Base
---| 'C'
---@protected
function C.x()
end
---@see C.x
function C.y()
end
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 ejecutando la exportación --doc sobre la reproducción en Lua del issue e inspecciona cómo representa su salida @see, los modificadores de acceso, la documentación de alias heredada y start/finish. Sigue el punto de entrada de la exportación de documentación y compara su salida con la información de anotaciones utilizada por el servidor de lenguaje. Se considera terminado cuando los datos exportados conservan los detalles de anotación solicitados y explican o corrigen los valores de rango.
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
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100