LuaLS / LuaLS/lua-language-server
Request for ability to skip adding to documentation, i.e. `---@nodoc`
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
At the moment, if I do anything that references _G, all of the documentation for _G populates the documentation. It would be nice to be able to prevent superfluous documentation - especially for stuff that's only local to the file and not exported for public use.
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 rastreando cómo se recopila la documentación cuando un archivo hace referencia a _G y, a continuación, identifica dónde podría reconocerse un marcador ---@nodoc. Se considera terminado cuando los símbolos locales o que no sean públicos por algún otro motivo pueden excluirse de la documentación generada sin eliminar la documentación de los símbolos públicos; el issue no menciona archivos ni pruebas, por lo que primero hay que localizar esos puntos de entrada.
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
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100