haskell-servant / haskell-servant/servant

greet.hs needs cleanup

Open
#1,336 0 comments 0 reactions 0 assignees View on GitHub
documentation help wanted servant-docs
Dominant language
Haskell
Stars
2k
Forks
427
Avg merge
2d 23h
Merged PRs (30d)
5

Description

We currently have a haskell module in `README.md` and another one in `example/greet.hs`. I think the two have diverged at some point in the past, but even if they've always been different, there should only be one example, so I suggest:

- [ ] replace the haskell code in `README.md` with a link to `example/greet.hs`
- [ ] make sure that `example/greet.hs` contains all the information from the README.
- [ ] add ci machinery that runs `greet.hs` and compares the output to `greet.md`, so the example can't get outdated any more.

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.