haskell/aeson

Document `Key` and mention it in the tutorial

Open

#985 opened on Jan 7, 2023

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Haskell (1,298 stars) (334 forks)batch import
help wanted

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

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic HaskellFamiliarity with aeson
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Add Haddock comments to the `Key` type in `Data/Aeson/Key.hs` to explain its motivation and how to obtain it from `Text`. Additionally, update the tutorial section in the Hackage docs (likely in `Data/Aeson.html`) to include an example of using non literal keys converted from `Text`.
Document `Key` and mention it in the tutorial · haskell/aeson#985 | Good First Issue