Document `Key` and mention it in the tutorial · haskell/aeson#985

(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
難度: 2
預計時間: 1-3 hours
活動狀態: fresh
清晰度: clear
前置要求: Basic HaskellFamiliarity with aeson
新手友善度: 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`.