haskell / haskell/aeson

Document `Key` and mention it in the tutorial

Open
#985 2 comments 1 reaction 0 assignees View on GitHub
help wanted
Dominant language
Haskell
Stars
1.3k
Forks
336
Avg merge
3d 7h
Merged PRs (30d)
4

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](https://hackage.haskell.org/package/aeson-2.1.1.0/docs/Data-Aeson.html#g:1)" 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

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.