haskell/aeson

Document `Key` and mention it in the tutorial

Open

#985 aberto em 7 de jan. de 2023

Ver no GitHub
 (2 comments) (1 reaction) (0 assignees)Haskell (334 forks)batch import
help wanted

Métricas do repositório

Stars
 (1.298 stars)
Métricas de merge de PR
 (Mesclagem média 89d 5h) (9 fundiu PRs em 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

Guia do colaborador

Direção de pesquisa
Adicione comentários Haddock ao tipo `Key` em `Data/Aeson/Key.hs` para explicar sua motivação e como obtê lo a partir de `Text`. Além disso, atualize a seção de tutorial na documentação do Hackage (provavelmente em `Data/Aeson.html`) para incluir um exemplo de uso de chaves não literais convertidas de `Text`.
Pilha de tecnologia
None
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Basic HaskellFamiliarity with aeson
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80