google / google/codeworld

Improved documentation for builtin symbols

Abierto
#814 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

Now that we have more visible documentation in the editor, it's conspicuous how much the documentation is missing for a lot of builtin symbols. It would be good to add documentation (which just means haddock in the codeworld-base module) for all these definitions.

At the same time, I should rewrite the existing documentation to be clearer about function arguments. We should adopt this style for the first sentence of every function:

@thickArc(angle1, angle2, radius, thickness)@ is a @Picture@ of an arc
between the given angles, with the given radius and line thickness.

The documentation can go on to give examples and such, but that first sentence clarifies what each argument means in a precise way.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza en el módulo codeworld-base y revisa las definiciones de símbolos integrados y sus comentarios Haddock existentes. Haz un inventario de las definiciones sin documentación y, después, revisa la documentación de las funciones para que la primera frase de cada una explique los argumentos con el estilo solicitado. La tarea estará completada cuando las definiciones de símbolos integrados tengan documentación Haddock y las descripciones existentes definan claramente sus argumentos de función.

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

Evaluación

Stack tecnológico
haskell
Área
documentation
Tipo de issue
Documentación
Dificultad
4/5
Tiempo estimado
Más de una semana
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.