Add a diagram to show the relationship between typeclasses

[julien-truffaut]

Even something as basic as the diagram from semigroupoid would be very useful. We can iterate and make it look nicer on a second step.

[non]

This is a great idea 👍

[xuwei-k]

http://xuwei-k.github.io/cats-2015-02-06.svg

[julien-truffaut]

Awesome!

[joshmarcus]

FWIW, I think the semigroupoid layout (text or not) is easier to digest and is a little more accessible.

[ceedubs]

Oh wow the boxes in @xuwei-k's diagram are links to the source. That's fantastic!

[stew]

ok, so we have sat on this for way too many months. can someone just integrate the @xuwei-k into our docs somewhere?

Is this something we can regenerate easily when stuff chnages? @xuwei-k ?

[xuwei-k]

Please feel free to use this :)

• xuwei-k@4549ac6d58c8
• https://github.com/xuwei-k/sbt-class-diagram
• http://xuwei-k.github.io/cats-2015-06-05.svg

[non]

I really like the idea of auto-generating diagrams a la sbt-class-diagram. However, I decided to take a crack at making a graph by hand to see if I could use color and layout to help give folks a better intuition about what is going on: http://plastic-idolatry.com/erik/cats-graph.png.

What do you all think? Auto-generating the graph (and keeping it automatically-updated) is really nice, but I think having colors, method names, and a manually layout may be nice too.

[julien-truffaut]

Nice, I think it is worth to have a hand made diagram, it can be much clearer and typeclasses should be pretty stable (in a few a releases).

[kevinwright]

Can we have the best of both worlds?

If sbt-class-diagram is already there, then it seems we're okay with a
dependency on graphviz.
So how doable is it to annotate typeclasses with colour and grouping hints
that get passed through to the dotty source?

On 22 June 2015 at 09:06, Julien Truffaut [email protected] wrote:

Nice, I think it is worth to have a hand made diagram, it can be much
clearer and typeclasses should be pretty stable (in a few a releases).

—
Reply to this email directly or view it on GitHub
https://github.com/non/cats/issues/95#issuecomment-114035082.

Kevin Wright
mail: [email protected]
gtalk / msn : [email protected]
quora: http://www.quora.com/Kevin-Wright
google+: http://gplus.to/thecoda
[email protected]
twitter: @thecoda
vibe / skype: kev.lee.wright
steam: kev_lee_wright

"My point today is that, if we wish to count lines of code, we should not
regard them as "lines produced" but as "lines spent": the current
conventional wisdom is so foolish as to book that count on the wrong side
of the ledger" ~ Dijkstra

[non]

@kevinwright That's an interesting idea.

@xuwei-k Do you think it would be possible to provide styling grouping hints to sbt-class-diagram? Do you have a sense of how well that might work?

[non]

(Also, here is the diagram for the C[_, _] type classes: http://plastic-idolatry.com/erik/cats-graph2.png)

[kailuowang]

I am going count this as fixed by #1416