Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation for Stack.Runners #2694

Open
sjakobi opened this issue Oct 9, 2016 · 1 comment
Open

Improve documentation for Stack.Runners #2694

sjakobi opened this issue Oct 9, 2016 · 1 comment

Comments

@sjakobi
Copy link
Member

sjakobi commented Oct 9, 2016

For #2692 I had to navigate the various runners and configuration types again.

This would have been easier if the module explained e.g. that the withXConfig functions are ordered by "power" and what information they carry in addition to the previous type. MiniConfig is the "largest" type that doesn't require an existing GHC installation to construct etc.

@sjakobi sjakobi added this to the P3: Optional milestone Oct 9, 2016
@mgsloan
Copy link
Contributor

mgsloan commented Oct 10, 2016

Agreed, this is something that sometimes puzzles me, so would be a great thing to document.

One way to make things clearer might be to use a concrete monad in more places: #1297

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants