Improve readability of annotation syntaxes
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Área
- documentation
Línea de trabajo
Comienza con la página enlazada annotations/#understanding-this-page y revisa los ejemplos de sintaxis compleja mostrados en el issue. El issue no define un reemplazo preferido ni una prueba clara de finalización; para darlo por terminado sería necesario acordar una notación más legible y actualizar los ejemplos de la documentación.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
The method currently used for describing how to use annotations can be easy to understand at times:
---@type <type>
And also impossible for mere mortals to understand:
---@cast <value_name> [+|-]<type|?>[, [+|-]<type|?>...]
---@overload fun([param: type[, param: type...]]): [return_value[,return_value]]
There must be a better way to represent these more complex syntaxes while also not using symbols regularly in use (<, >, (, ), [, ], {, }, @, #, -, +, =, :, ", ,, ., ?). Although now that I have listed some in-use symbols, I realize we really are quite limited. It is hard to explain a syntax that uses many symbols… using symbols.
I'm open to any suggestions on how this can be improved 🙂
- Lenguaje dominante
- MDX
- Estrellas
- 10
- Forks
- 19
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la 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.
Issues similares
-
TLS guide repeats certs/ in the certificate directoryPosiblemente ocupada @maheshrijal la tomó hoy. Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
prometheus/docs#3156 ·
Los mantenedores suelen responder en 2 días
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 75/100
Los mantenedores suelen responder en 1 día
-
feedback simulation workshop
Dificultad 2/5 1-3 horas Aptitud para principiantes 64/100
githubnext/gh-aw-workshop#5009 ·
Los mantenedores suelen responder en 1 día
-
A practical example of rulerAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
Course help wanted Sensei
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100