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

added instance table to docs, enhanced typeclass diagram #1565

Merged
merged 9 commits into from
May 13, 2017

Conversation

kailuowang
Copy link
Contributor

@kailuowang kailuowang commented Mar 20, 2017

UPDATE: I switched to tpolecat's infographic. But Don't merge yet, it seems to me that microsites doesn't support .svg files, see 47degrees/sbt-microsites#182
SVG issue resolved ready to review/merge.
Originally from @alexknvl
The instance table

Type Functor Apply Applicative Monad MonoidK ApplicativeError MonadError CoflatMap Comonad
Id[A]
Eval[A]
Option[A]
Const[K, A] ✔ (K:Monoid)
Either[E, A]
List[A]
NonEmptyList[A]
Stream[A]
Map[K, A]
Validated[E, A] ✔ (E: Semigroup) ✔ (E: Semigroup)
Reader[E, A]
Writer[E, A] ✔ (E:Monoid)

The typeclass infograph from @tpolecat

@codecov-io
Copy link

codecov-io commented Mar 20, 2017

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1565   +/-   ##
=======================================
  Coverage   93.37%   93.37%           
=======================================
  Files         240      240           
  Lines        3941     3941           
  Branches      141      138    -3     
=======================================
  Hits         3680     3680           
  Misses        261      261

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 404f348...24fda91. Read the comment docs.

@peterneyens
Copy link
Collaborator

This sort of solves #1287.

@kailuowang kailuowang changed the title added instance table to docs added instance table to docs, enhanced typeclass diagram Mar 21, 2017
@juanpedromoreno
Copy link
Contributor

@kailuowang Regarding the svg issue, I think the problem might be related to Jekyll filtering:

Could you please try to put below this line the next sbt config?

includeFilter in Jekyll := "*.html" | "*.css" | "*.png" | "*.jpg" | "*.gif" | "*.js" | "*.swf" | "*.yml" | "*.md" | "*.svg"

The trick would be using Jekyll scope (you might even combine the same includeFilter for both makeSite and Jekyll scopes).

Let me know if that solves the issue.

@kailuowang
Copy link
Contributor Author

@juanpedromoreno that indeed fixed the issue. Thanks very much!

@kailuowang kailuowang removed the Blocked label May 4, 2017
Copy link
Member

@rossabaker rossabaker left a comment

Choose a reason for hiding this comment

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

Both the graphic and the table are great.

@djspiewak
Copy link
Member

@tpolecat The graph is amazing, though unfortunately it's a bit out of date on the cats-effect front since we had to make Async <: Sync directly, rather than sitting in parallel.

@tpolecat
Copy link
Member

tpolecat commented May 9, 2017

@kailuowang is it possible/desirable to link directly to the SVG in my repo so it gets updated automatically?

@kailuowang
Copy link
Contributor Author

@tpolecat it's certainly desirable from my point of view. In fact, that's the first thing I tried. I couldn't find a url of it that points to the latest version and with the right content type. Maybe you have to publish it to gh-pages? (or just make gh-pages your main branch?)

@tpolecat
Copy link
Member

tpolecat commented May 9, 2017

The internet showed me this trick but I don't know if it's a reasonable long-term solution. Below the link is:

https://cdn.rawgit.com/tpolecat/cats-infographic/master/cats.svg

The embedded png file isn't showing up but I'm not sure what to do about that. I could just remove it, it doesn't really add anything.

@johnynek
Copy link
Contributor

johnynek commented May 9, 2017

@kailuowang
Copy link
Contributor Author

@tpolecat awesome! Just updated. I think a midterm solution is good enough for now.

@kailuowang
Copy link
Contributor Author

@johnynek good catch, fixed.

@tpolecat
Copy link
Member

tpolecat commented May 9, 2017

@kailuowang I updated the infographic but it's not showing up on the cdn yet. It may be cached for a while.

Update: it updated at some point so I think we're good.

@kailuowang
Copy link
Contributor Author

ping @johnynek. Do yo have time to take another look?

Copy link
Contributor

@ceedubs ceedubs left a comment

Choose a reason for hiding this comment

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

Nice stuff!

@ceedubs ceedubs merged commit 5340ee6 into typelevel:master May 13, 2017
@kailuowang kailuowang added this to the 1.0.0-MF milestone Aug 1, 2017
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.

9 participants