haskell-servant / haskell-servant/servant

Inconsistent documentation for Client

Open
#933 1 comment 0 reactions 1 assignee Claimed by @alpmestan View on GitHub
documentation servant-client
Dominant language
Haskell
Stars
2k
Forks
427
Avg merge
2d 23h
Merged PRs (30d)
5

Description

skarmavbild 2018-03-25 kl 21 26 45

The above haddock says that the reader should ignore the `RunClient` typeclass, and the associated `Client` type (since it's undocumented).

However, lots of functions return `Client` which means the user cannot ignore understanding what it is.

The documentation should be updated.

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.