haskell/aeson

Document `Key` and mention it in the tutorial

Open

#985 ouverte le 7 janv. 2023

Voir sur GitHub
 (2 commentaires) (1 réaction) (0 assignés)Haskell (334 forks)batch import
help wanted

Métriques du dépôt

Stars
 (1 298 stars)
Métriques de merge PR
 (Merge moyen 89j 5h) (9 PRs mergées en 30 j)

Description

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 Key that 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

Guide contributeur

Direction de recherche
Ajoutez des commentaires Haddock au type `Key` dans `Data/Aeson/Key.hs` pour expliquer sa motivation et comment l'obtenir à partir de `Text`. De plus, mettez à jour la section tutoriel dans la documentation Hackage (probablement dans `Data/Aeson.html`) pour inclure un exemple d'utilisation de clés non littérales converties à partir de `Text`.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Basic HaskellFamiliarity with aeson
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80