haskell/aeson

Document `Key` and mention it in the tutorial

Open

#985 aperta il 7 gen 2023

Vedi su GitHub
 (2 commenti) (1 reazione) (0 assegnatari)Haskell (334 fork)batch import
help wanted

Metriche repository

Star
 (1298 star)
Metriche merge PR
 (Merge medio 89g 5h) (9 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Aggiungi commenti Haddock al tipo `Key` in `Data/Aeson/Key.hs` per spiegarne la motivazione e come ottenerlo da `Text`. Inoltre, aggiorna la sezione tutorial nella documentazione di Hackage (probabilmente in `Data/Aeson.html`) per includere un esempio di utilizzo di chiavi non letterali convertite da `Text`.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Basic HaskellFamiliarity with aeson
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80