Thanks to visit codestin.com
Credit goes to github.com

Skip to content

WIP: Improve interop with cats effect documentation #4965

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 13 commits into from
Jun 26, 2021
Merged

WIP: Improve interop with cats effect documentation #4965

merged 13 commits into from
Jun 26, 2021

Conversation

@khajavi
Copy link
Member

@khajavi khajavi commented Apr 16, 2021 •
edited
Loading

I've updated this documentation to be more straightforward for begginers.

  • ZStream
  • ZQueue
  • ZManaged
  • STM
  • Doobie
  • http4s

@khajavi khajavi force-pushed the zio-interop-cats-documentation branch from 551bf7a to dd5fbcb Compare April 19, 2021 14:45
@khajavi khajavi force-pushed the zio-interop-cats-documentation branch from dd5fbcb to e42490b Compare May 3, 2021 10:37
@khajavi khajavi force-pushed the zio-interop-cats-documentation branch from e42490b to 0c195ce Compare June 25, 2021 07:01
jdegoes
jdegoes reviewed Jun 25, 2021
View reviewed changes
@khajavi khajavi changed the title Improve interop with cats effect documentation WIP: Improve interop with cats effect documentation Jun 25, 2021
@khajavi
Copy link
Member Author

khajavi commented Jun 25, 2021 •
edited
Loading

Some ongoing works:

  • Migrate examples to CE3
  • Add fs2 streaming example as a separate one.
  • Cover both sides of conversion in each section (from ZIO to Cats Effect and vice versa)
  • Cover recent changes of interop-cats library.

@adamgfraser
Copy link
Contributor

@khajavi It may be good to have separate sections on migrating from Cats Effect 2 and Cats Effect 3.

@khajavi
Copy link
Member Author

khajavi commented Jun 25, 2021

@khajavi It may be good to have separate sections on migrating from Cats Effect 2 and Cats Effect 3.

Good point! But how to manage maintainable running code with mdoc?
In the build.sbt, we can only specify one version, Cats Effect 2 or Cats Effect 3. Do you have any idea how to manage that?
Last time I discussed this issue with @jdegoes, he said that it is better to maintain one version on Cats Effect 3.

@jdegoes
Copy link
Member

jdegoes commented Jun 25, 2021

I think we can choose the "compiling" one to be CE3, but still support CE2 migration guide that does not compile.

@jdegoes jdegoes merged commit 8a7472d into zio:master Jun 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jdegoes jdegoes jdegoes approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@khajavi @adamgfraser @jdegoes