haskell/aeson

Document `Key` and mention it in the tutorial

Open

#985 geöffnet am 7. Jan. 2023

Auf GitHub ansehen
 (2 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Haskell (334 Forks)batch import
help wanted

Repository-Metriken

Stars
 (1.298 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 89T 5h) (9 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Füge Haddock Kommentare zum `Key` Typ in `Data/Aeson/Key.hs` hinzu, um seine Motivation und die Methode zur Erstellung aus `Text` zu erklären. Aktualisiere außerdem den Tutorial Abschnitt in der Hackage Dokumentation (wahrscheinlich in `Data/Aeson.html`), um ein Beispiel für die Verwendung von nicht literalen, aus `Text` konvertierten Schlüsseln aufzunehmen.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Basic HaskellFamiliarity with aeson
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80