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

Add Scaladoc for Zipper. #135

Open
milessabin opened this issue Jun 26, 2014 · 3 comments
Open

Add Scaladoc for Zipper. #135

milessabin opened this issue Jun 26, 2014 · 3 comments

Comments

@milessabin
Copy link
Owner

@milessabin milessabin commented Jun 26, 2014

No description provided.

@vil1
Copy link
Contributor

@vil1 vil1 commented Oct 23, 2017

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
Copy link

@lemastero lemastero commented Jan 24, 2019

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
Copy link
Contributor

@kazchimo kazchimo commented May 16, 2020

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
5 participants
You can’t perform that action at this time.