haskell/aeson

Document `Key` and mention it in the tutorial

Open

#985 创建于 2023年1月7日

在 GitHub 查看
 (2 评论) (1 反应) (0 负责人)Haskell (334 fork)batch import
help wanted

仓库指标

Star
 (1,298 star)
PR 合并指标
 (平均合并 935天 9小时) (30 天内合并 5 个 PR)

描述

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

贡献者指南