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

Add StateT and trampolining to State documentation #387

Open
ceedubs opened this issue Jun 29, 2015 · 3 comments
Open

Add StateT and trampolining to State documentation #387

ceedubs opened this issue Jun 29, 2015 · 3 comments

Comments

@ceedubs
Copy link
Contributor

ceedubs commented Jun 29, 2015

Documentation for State was added in #384. However, it still has a TODO at the end for documenting how StateT relates to State and how/why trampolining is used for State. This TODO should be replaced with documentation.

@LukaJCB
Copy link
Member

LukaJCB commented May 27, 2017

Maybe we should explain the concept of Monad Transformers at some sort of central location? Some of the motivation and explanation already exists in the OptionT documentation. We could take some of that and make some sort of Monad Transformer section, or we duplicate some of the documentation, which I'd personally also be okay with.

Another thought I have, is that cats-mtl is going to be a different package soon AFAIK, so there might also be some duplication there.

@edmundnoble
Copy link
Contributor

edmundnoble commented May 27, 2017

cats-mtl will provide documentation about monad transformers in general, yes.

Edit: Because it will not provide the transformers themselves, and not the type classes, it may be a bit unusual to document them in cats-mtl. What do others think?

@kailuowang
Copy link
Contributor

related #1714
TLDR, we may need a reformulation of StateT.

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

4 participants