haskell/aeson

Document `Key` and mention it in the tutorial

Aberta

#985 aberto em 7 de jan. de 2023

Ver no GitHubGuia do colaborador
 (2 comentários) (1 reação) (0 responsável)Haskell (334 forks)batch import
help wanted

Métricas do repositório

Stars
 (1.298 estrelas)
Métricas de merge de PR
 (Mesclagem média 935d 9h) (5 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
Revise a documentação existente de Key e a seção de tutorial no aeson, depois adicione comentários Haddock e um exemplo mostrando a conversão de Text.
Pilha de tecnologia
haskell
Domain
api
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.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Haskell
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70