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 (334 forks)batch import
help wanted

Repository metrics

Stars
 (1,298 stars)
PR merge metrics
 (Avg merge 935d 9h) (5 merged PRs in 30d)

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

Research direction
Review the existing Key documentation and tutorial section in aeson, then add haddock comments and an example showing conversion from Text.
Tech stack
haskell
Domain
api
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Haskell
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70