haskell/aeson

Document `Key` and mention it in the tutorial

Open

#985 创建于 2023年1月7日

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

描述

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

贡献者指南

技术栈
无
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Basic HaskellFamiliarity with aeson
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
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`.