Images in the documentation about elm-algebraic-graph HOT 2 CLOSED

No, I don't suggest changing the names, even though overlay gives a little bit more intuition about not adding any edges. I think union and product are mostly fine, just that the documentation could say / show that it doesn't add / does add edges, and how.

from elm-algebraic-graph.

Hi !
Thanks for the suggestion. I do plan to improve the documentation a bit in the coming weeks (or maybe next month, I have some college exams soon), especially by adding some code examples for the different library functions that show their effects better.

The point you raise is interesting – do you think that using union and product is not appropriate in this context, and that the library should switch to the original paper terminology with overlay and connect ? I originally thought that union would be consistent with Elm core's Set.union, and that product would remind the user of Cartesian products.

This is definitely a question that requires an answer before the next major release though, so we can integrate an breaking change to use better naming conventions. Thanks for pointing that out !

from elm-algebraic-graph.