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 a documentation page for Nested #2369

Merged
merged 1 commit into from
Aug 8, 2018

Conversation

cb372
Copy link
Contributor

@cb372 cb372 commented Aug 7, 2018

If anyone has more motivating examples, I'm happy to add them.

Copy link
Member

@LukaJCB LukaJCB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was long overdue thanks a bunch for working on it! 👏

One thing we should do in the future is to replace the instances of Future we have in parts of our documentation with IO, but for now it's alright :)

@cb372
Copy link
Contributor Author

cb372 commented Aug 7, 2018

Yeah actually the example we discussed on Twitter originally used IO but I "downgraded" it to Future :)

I guess porting the examples to IO would mean adding a library dependency on cats-effect for the docs module. That feels a little weird. Or move the docs module into its own repo? That has its downsides as well: it means you can't add a new feature and write the docs for it at the same time.

@codecov-io
Copy link

Codecov Report

Merging #2369 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2369   +/-   ##
=======================================
  Coverage   95.01%   95.01%           
=======================================
  Files         349      349           
  Lines        5998     5998           
  Branches      221      222    +1     
=======================================
  Hits         5699     5699           
  Misses        299      299

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c302177...44ff746. Read the comment docs.

@LukaJCB
Copy link
Member

LukaJCB commented Aug 7, 2018

Yeah we've had the discussion before about Free and what we'd interpret into. I think we could definitely take a dependcy just for the docs module once cats-effect is stable :)

@kailuowang
Copy link
Contributor

@LukaJCB having cats-effect as a dependency in docs might make things hairy when we start to have breaking changes (say going 3.0), but I guess in that case we need to coordinate with Cats-effect anyway. So 👍

Copy link
Contributor

@kailuowang kailuowang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks so much!

@kailuowang kailuowang merged commit aae5d26 into typelevel:master Aug 8, 2018
@kailuowang kailuowang added this to the 1.3 milestone Aug 16, 2018
catostrophe pushed a commit to catostrophe/cats that referenced this pull request Sep 15, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants