Document `Key` and mention it in the tutorial
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 48/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- haskell
- Área
- documentation
Línea de trabajo
Comienza con la página Haddock de Data.Aeson.Key y la sección del tutorial “How to use this library” enlazada en el issue. Lee la documentación de la API circundante y los ejemplos antes de actualizarlos. La tarea estará terminada cuando Key explique por qué existe y cómo obtenerlo, y el tutorial incluya una clave no literal convertida desde Text.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
In https://hackage.haskell.org/package/aeson-2.1.1.0/docs/Data-Aeson-Key.html#t:Key there are no haddocks, and the "How to use this library" section has not a single example that shows non-literal keys being used (coming e.g. from Text).
It would be great if:
- Haddocks were added to
Keythat motivate its existence, so that e.g. hovering it from an IDE gives tips on how to obtain that type - an example of keys being converted from
Text, so that beginners or upgraders from pre-2.0 have an esier time
- Lenguaje dominante
- Haskell
- Estrellas
- 1.3k
- Forks
- 338
- 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.
Más de haskell/aeson
-
allow tagged-0.9 for ghc-9.14Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
There doesnt' seem to be `throwDecodeFile :: (HasCallStack, FromJSON a) => FilePath -> IO a`Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
Todos los issues de haskell/aeson
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
objectionary/phino#2059 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
NixOS/nixpkgs-update#586 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 83/100
wireapp/wire-server#5632 ·
Los mantenedores suelen responder en 2 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
koalaman/shellcheck#3593 ·