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 effect documentation #913

Open
LordMZTE opened this issue Oct 1, 2021 · 1 comment
Open

Improve effect documentation #913

LordMZTE opened this issue Oct 1, 2021 · 1 comment
Labels

Comments

@LordMZTE
Copy link

LordMZTE commented Oct 1, 2021

Currently, to a newcomer the documentation on effects in the book might be a little confusing. Here's some things I think could do with some improvement:

  • make it clear that the name of effects in the effect row is important
  • explain a little of how the get, put and modify actions work internally and how they access the state effect
  • explain what the Eff type is and how it's declared, and in the Embedding API chapter explain what this kind of type is good for and how to add it to a project
  • add some more in-depth explanation to what lift does
  • what do the run_lift and eval_state functions do so they're able to be chained as in the guessing game example, and how can effects be run sequentially like this?
@Marwes Marwes added the docs label Oct 1, 2021
@rahulc29
Copy link

Hey I would be willing to work on this. I would like to know exactly how effects are implemented? Using monads, a la Haskell? Algebraic effects a la Eff? Non-well-founded trees as in the ooAgda library? Also, it would be a great help if you could point me to where the code for effects is.

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

No branches or pull requests

3 participants