haskell / haskell/containers

Proposal: New Haddock doc format

Open
#486 9 comments 0 reactions 2 assignees Claimed by @wrengr View on GitHub
docs
Dominant language
Haskell
Stars
355
Forks
194
Avg merge
3d 4h
Merged PRs (30d)
4

Description

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)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.