Document the effects and their carriers. #251
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
patrickt
commented
Oct 6, 2019
robrix
suggested changes
Oct 8, 2019
Co-Authored-By: Rob Rix <robrix@github.com>
Co-Authored-By: Rob Rix <robrix@github.com>
Co-Authored-By: Rob Rix <robrix@github.com>
Co-Authored-By: Rob Rix <robrix@github.com>
Co-Authored-By: Rob Rix <robrix@github.com>
Co-Authored-By: Rob Rix <robrix@github.com>
Co-Authored-By: Rob Rix <robrix@github.com>
Co-Authored-By: Rob Rix <robrix@github.com>
Co-Authored-By: Rob Rix <robrix@github.com>
Co-Authored-By: Rob Rix <robrix@github.com>
Co-Authored-By: Rob Rix <robrix@github.com>
Co-Authored-By: Rob Rix <robrix@github.com>
robrix
approved these changes
Oct 10, 2019
src/Control/Effect/Class.hs
Outdated
| @@ -1,4 +1,6 @@ | |||
| {-# LANGUAGE DefaultSignatures, EmptyCase, FlexibleContexts, FlexibleInstances, MultiParamTypeClasses, RankNTypes, TypeOperators #-} | |||
|
|
|||
| -- | Provides the 'HFunctor' and 'Effect' classes that an effect type implements so that a carrier monad can provide an instance of 'Carrier' for that type. | |||
There was a problem hiding this comment.
Carrier isn’t in scope here, and IMO we don’t need to mention it.
src/Control/Effect/Resumable.hs
Outdated
Comment on lines
35
to
37
| -- Note that the type parameters in the @err a@ paramater and @m a@ parameter must match | ||
| -- up; this is so that the calling context knows what type of value this computation | ||
| -- expected in the success case. |
There was a problem hiding this comment.
-
Suggest: “…; this indicates the type that the error must be resumed with.”
-
Soft wrap, please 🙏
Co-Authored-By: Rob Rix <robrix@github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#240 mentioned, very correctly, that our documentation was a little sparse, and that’s a problem that only grew worse with the various reorganizations on the road to 1.0. This patch remedies that.
Fixes #244.