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 · 1 comment

Comments

Projects
None yet
2 participants
@milessabin
Owner

milessabin commented Jun 26, 2014

No description provided.

@vil1

This comment has been minimized.

Show comment
Hide comment
@vil1

vil1 Oct 23, 2017

Contributor

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.
Contributor

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment