-
Notifications
You must be signed in to change notification settings - Fork 17
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
Add module documentation for Mealy #39
Add module documentation for Mealy #39
Conversation
Thanks! You can update the changelog if you would like, under the "Other improvements" section. Documentation updates are worthy of recognition in the changelog, I think, though it's not necessary if you don't want to. |
I think doc updates should be included, not so much for the recognition, but more because those who didn't understand this library beforehand can be notified to look at it again and see whether it makes sense now. |
All right, will do so on both PR's. |
-- | For example, logging could be used as a sink: | ||
-- | ```purescript | ||
-- | take 10 $ source (pure 1) >>> sink logShow | ||
-- | ``` | ||
sink :: forall f a. (Monad f) => (a -> f Unit) -> Sink f a |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As I look at these, this Monad
constraint looks too powerful. Just a thought, but perhaps in a later PR we could relax this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I also noticed that but assumed it was a deliberate decision that I didn't understand...? If it's not, then I'll be happy to fix them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we ought to, if you’re up for it!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have a couple suggestions in here, but overall this is a serious improvement and the comments you've written are concise and clear. Thank you for taking the time to add these. 👍
I think I addressed all review commends. I also added a line in the changelog. |
Excellent! Thanks so much. |
Description of the change
Fixes #35 . It's far from perfect, but perhaps it's a decent start?
Should I update the changelog if I'm not changing any code?
Checklist: