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

please more documentation / examples :) #13

Open
jampy opened this issue Aug 4, 2014 · 1 comment
Open

please more documentation / examples :) #13

jampy opened this issue Aug 4, 2014 · 1 comment

Comments

@jampy
Copy link

jampy commented Aug 4, 2014

[Please pardon me, if opening an issue for this is bad practice, but I don't know how to open a disussion here by other means.]

As I think your solution beats all others out there in simplicity, I hope you can extend the API documentation a bit more and explain in depth the parameters. For example, how should those Array-Functions be used?

The tutorial is great, but ends up a bit complex to explain concepts like parallelism (forEachStar). I'd love to see a small, but focused example instead.

Anotehr suggestion: For people like me that are new to generators and alike, it's often difficult to understand when to write yield generator or yield generator() and details like these. So, it helps when example code is written verbosely (like, use intermediary variables instead of declaring a generator and immediately calling it, generating a bunch of parenthesis).

Please don't get me wrong. I don't want to criticize. Instead, I hope more people will understand and use your solution. I really love it, and prefer it to all other generator-based solutions I've seen so far (I've studied nearly 10 approaches). Thumbs up!

@bjouhier
Copy link
Owner

bjouhier commented Aug 4, 2014

No problem. I have a tendency to pack too much stuff into my examples. I'll try to improve the doc but it's actually easier for me to answer specific questions. So don't hesitate to post more questions here.

I did not create a mailing list for this project. So this is the right place to ask.

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

No branches or pull requests

2 participants