LuaLS / LuaLS/lua-language-server
[Feature Request] Add additional fields to exported docs
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
Right now, it's very difficult to parse the exported docs. I've mostly been able to figure stuff out, but there's a bit of information the exported JSON file does not expose, which I would like to suggest.
- A field for which class something originates from, to filter out unchanged methods/fields from parents
- A relative version of
file, instead of an absolute path - A version of the description which does not include markdown for params and return values, since those are separate
- Whether a function is deprecated or not
- A way to hide a field or method from the docs export (
---@nodoc?) - Maybe a way to not export inherited fields/methods? The exported file for my project is more than a million lines long...
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 localizando la implementación del JSON de documentación exportado y el código que ensambla los campos para funciones, métodos y campos. Revisa cómo se representan actualmente la herencia, las rutas de archivos, las descripciones y la obsolescencia; el trabajo estaría terminado cuando haya un alcance acordado y pruebas que cubran los campos de exportación seleccionados y el comportamiento de nodoc o de la herencia.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- lua
- Área
- documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 25/100