haskell-servant/servant

Better document (just response?) headers

Open

#1.493 aberto em 2 de dez. de 2021

Ver no GitHub
 (0 comments) (1 reaction) (0 assignees)Haskell (422 forks)batch import
documentationenhancementhelp wanted

Métricas do repositório

Stars
 (1.953 stars)
Métricas de merge de PR
 (Mesclagem média 23h 44m) (4 fundiu PRs em 30d)

Description

While we know the effect of Header (and its general variant that allows modifiers) when used for request headers, we don't have much doc or examples when using Headers '[ ... ] in response headers. Whether the response headers necessarily have to be there or not (no, see noHeader), whether modifiers affect the necessity for headers to be there or not, from server & client perspective, etc.

It would be great to have tests that cover all the cases/angles and a slightly more helpful documentation around this whole topic (in the haddocks for sure and perhaps the tutorial/cookbook?).

Guia do colaborador

Direção de pesquisa
Revise a documentação e os testes existentes sobre cabeçalhos no repositório Servant. Identifique as lacunas para cabeçalhos de resposta e modificadores como 'noHeader'. Escreva novos testes cobrindo todos os casos e atualize a documentação haddock e possivelmente o tutorial.
Pilha de tecnologia
None
Domain
backend
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-2 dias
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.
Principalmente claro
Prerequisites
HaskellServant
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70