Skip to content

Improve documentation #31

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

Open
milesfrain opened this issue Dec 21, 2020 · 0 comments · May be fixed by #35
Open

Improve documentation #31

milesfrain opened this issue Dec 21, 2020 · 0 comments · May be fixed by #35
Labels
type: documentation Improvements or additions to documentation.

Comments

@milesfrain
Copy link

This library would greatly benefit from a guide that describes how to use unfoldr. The current explanation is pretty terse.

I was initially led here from Data.Map.Internal.toUnfoldable, which was pretty confusing. It also took me a while to realize that the argument to go is a "todo list" of subtrees to process.

Some resources that I found helpful to get more comfortable with unfoldr are:

I'd like to incorporate some of that content (and perhaps some additional examples and explanation) into the official library docs.

@milesfrain milesfrain linked a pull request May 2, 2021 that will close this issue
4 tasks
@JordanMartinez JordanMartinez added the type: documentation Improvements or additions to documentation. label Dec 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants