Add Scaladoc for Zipper.

vil1 commented 6 years ago

Hi, coming there from codetriage.

IMO, what's missing is a proper introduction on what a Zipper makes possible, attached as a scaladoc comment on the Zipper class.

It would need to provide examples of Zipper usage in the same way, eg, the scaladoc for Generic does (@milessabin, please correct me if it's not what you had in mind).

A few more information to help people fixing this issue :

the shapeless Zipper definition is here
a valuable source of inspiration about zippers in general can be found on wikipedia
as always, the tests are a good source of inspiration too.

lemastero commented 5 years ago

There are a couple of nice presentations:

Zippers by Example - George Wilson (youtube)
Zippers, Comonads & Data Structures in Scala - Mark Hibberd & Tony Morris (youtube)

There are many blogposts about Zippers:

I could digest this and cast it in the context of Shapeless, but It would not happen fast.

kazchimo commented 4 years ago

If anyone dosen't do this issue, can I take this?

It would be difficult to add Scaladoc as a full tutorial of Zipper because it has lots of operation. So the test cases bellow look suited for the doc of usual cases.

Does anybody have the idea for the good Zipper docs?

milessabin / shapeless

Add Scaladoc for Zipper. #135