search

grncdr / merge-stream

Merge multiple streams into one interleaved stream
MIT License
214 stars 16 forks source link

Improve documentation #23

Closed SetTrend closed 8 years ago

SetTrend commented 8 years ago

Would you mind improving the documentation?

I'm missing a full example. Particularly one explaining of how to merge an arbitrary number of streams into one. Does the constructor take an array of streams? How is merge-stream supposed to be used in the context of gulp?

Thanks for clarifying.

shinnn commented 8 years ago

Does the constructor take an array of streams?

You can read the very small code to understand what it actually does completely. https://github.com/grncdr/merge-stream/blob/master/index.js

How is merge-stream supposed to be used in the context of gulp?

https://github.com/gulpjs/gulp/blob/36374495496b7893ce42116e10b878debd136b1f/docs/recipes/using-multiple-sources-in-one-task.md

SetTrend commented 8 years ago

Yes, you are right. I already did now. :checkered_flag: Yet I would have preferred to just read the .md.

shinnn commented 8 years ago

Anyway, as @SetTrend suggested, API doc with argument types (like deep-extend-stream doc) is useful for users.

stevemao commented 8 years ago

@SetTrend PR welcome to improve the docs