haskell-servant/servant

Better document (just response?) headers

Open

#1,493 创建于 2021年12月2日

在 GitHub 查看
 (0 评论) (1 反应) (0 负责人)Haskell (422 fork)batch import
documentationenhancementhelp wanted

仓库指标

Star
 (1,953 star)
PR 合并指标
 (平均合并 5小时 49分钟) (30 天内合并 2 个 PR)

描述

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

贡献者指南