haskell-servant/servant

Better document (just response?) headers

Open

#1.493 geöffnet am 2. Dez. 2021

Auf GitHub ansehen
 (0 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Haskell (422 Forks)batch import
documentationenhancementhelp wanted

Repository-Metriken

Stars
 (1.953 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 23h 44m) (4 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide