haskell-servant/servant

Better document (just response?) headers

Open

#1493 aperta il 2 dic 2021

Vedi su GitHub
 (0 commenti) (1 reazione) (0 assegnatari)Haskell (422 fork)batch import
documentationenhancementhelp wanted

Metriche repository

Star
 (1953 star)
Metriche merge PR
 (Merge medio 23h 44m) (4 PR mergiate in 30 g)

Descrizione

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?).

Guida contributor

Direzione di ricerca
Rivedere la documentazione e i test esistenti sugli header nel repository Servant. Identificare le lacune per gli header di risposta e i modificatori come 'noHeader'. Scrivere nuovi test che coprano tutti i casi e aggiornare la documentazione haddock e eventualmente il tutorial.
Tech stack
Nessuno
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
HaskellServant
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70