Use more concrete examples #28

Open
brian-gates opened this Issue Feb 17, 2014 · 5 comments

Projects

None yet

7 participants

@brian-gates

There's a lot of ambiguity in the examples that slowed me down in understanding what exactly was going on. I think if the examples were fully functional, it would help a lot in quickly learning what this library is capable of.

For example, readFile here is left to the users' imagination. A concrete, working example that I can use out of the box would be more helpful:

var data = _(filenames).map(readFile).parallel(4);
@markstos

Agreed. One format could be a chart which maps features from the 'async' library to the highland equivalent.

I tried a map().parallel(n) action, but it does nothing. I think the issue is that I don't have anywhere I want to pipe() the data to. The transformation step in map() is all I need.

@caolan
Owner
caolan commented Mar 9, 2014

@markstos sounds like that map() is really an each() - using each() causes a 'thunk' so it'll pull the data through like piping

@focusaurus

👍 Please make all the examples small but complete programs that you could save as a file run pass to node and have it work. Many of them are really really biased towards "the reader fully understands everything EXCEPT what this specific function does". data.pipe(output); is really frustrating.

@LewisJEllis LewisJEllis referenced this issue Jan 3, 2015
Open

cookbook? #188

@carlskii

👍 - Yes I spent hours on what looks to be very useful. I can't work out how to use it.

@vqvu vqvu self-assigned this Sep 15, 2016
@vqvu
Collaborator
vqvu commented Sep 15, 2016

Thanks for the prod. I definitely agree that our examples need work. I'll try to flesh them out some.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment