haskell-servant/servant

Better document (just response?) headers

Open

#1,493 建立於 2021年12月2日

在 GitHub 查看
 (0 留言) (1 反應) (0 負責人)Haskell (1,953 star) (422 fork)batch import
documentationenhancementhelp wanted

描述

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

貢獻者指南