google / google/codeworld

Parameter names in auto-generated docs for builtin symbols

Abierto
#815 0 comentarios 0 reacciones 0 asignados Ver en GitHub
enhancement
Lenguaje dominante
Haskell
Estrellas
1.3k
Forks
201
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

The autogenerated docs for built-in symbols currently just have a line number. In certain cases (at least when it's easy) it would be great to include the parameter names from a function declaration. There are hard cases, such as when a function has multiple parameters and doesn't use the same name each time -- or even pattern matches so there is no name for the overall parameter. It's okay to skip these (except for tuples, of course).

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

No se nombra ningún archivo ni prueba. Empieza por localizar el código que genera la documentación para símbolos integrados y sigue cómo se representan las declaraciones de funciones; el resultado deseado es mostrar los nombres de los parámetros cuando no haya ambigüedad, omitir los casos no compatibles y seguir gestionando las tuplas.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
haskell
Á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

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.