LuaLS / LuaLS/lua-language-server
How to annotate default arguments to parameters
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
Is there a standard way to annotate default arguments? I believe in LDoc you can do:
-- @string[opt='gregorian'] calendar optional calendar
-- @int[opt=0] offset optional offset
I'm currently converting some docs over and couldn't find anything in the wiki.
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 wiki del proyecto y la documentación existente sobre anotaciones; después, compara la sintaxis compatible con los ejemplos de LDoc del issue. Documenta la forma estándar de expresar argumentos predeterminados o aclara que la sintaxis no es compatible, para que los usuarios que conviertan documentación puedan determinar la anotación correcta.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- lua
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 42/100