haskell / haskell/binary

Improve README.md

Abierto
#28 2 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
Haskell
Estrellas
120
Forks
70
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

The README.md file has been converted to Markdown and been slightly extended.

Here are some further changes I'd like to see:

Not sure if it's still portable to Hugs. We claim it is, but I doubt it.

The section about "Using binary". I think this section is not too helpful. It could be more structured of the alternatives and with links to the relevant haddocks.

Deriving binary instance section. This is outdated and missleading. We can now generate instances with GHCs generics. A small example of how to do so, or link to the haddocks, would be better suiting.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

Empieza leyendo README.md, centrándote en la afirmación de portabilidad de Hugs, la sección “Using binary” y la sección sobre deriving. Comprueba los Haddocks actuales y las indicaciones sobre GHC generics antes de editar; se considera terminado cuando README describe con precisión la portabilidad, presenta alternativas de uso con enlaces relevantes y muestra o enlaza al enfoque moderno para generar instancias.

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
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
42/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.