haskell / haskell/containers

Proposal: New Haddock doc format

未关闭
#486 9 条评论 0 个 reaction 已指派 2 人 已被 @wrengr 认领 在 GitHub 查看
docs
主要语言
Haskell
星标
355
派生
194
平均合并
3 天 4 小时
30 天内合并 PR
4

描述

Hey, I'd like to get everyone's thoughts on the following formatting change to the Haddocks used throughout the containers package.

## Old

- Everything on one line (for the most part)
- Complexity the first thing in the docs (important, but not THAT important)
- Examples expanded by default

![fromlistwithold](https://user-images.githubusercontent.com/700646/34804516-e88e6570-f62d-11e7-9a70-582fa4a2f79b.png)

## New

- First line is a one sentence summary
- Followed by longer description with more details on args and caveats
- "See also" line
- "Complexity:" line
- Examples (collapsed by default), description of example followed by code and output

![fromlistwithnew](https://user-images.githubusercontent.com/700646/34804568-24b7c2ee-f62e-11e7-8f8a-31092abfb4eb.png)

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。