Commit 9d9abd26492b94a6b650b38e7db4ef41257d64d7
update docs
nichoth authored on 10/13/2016, 10:58:53 PMGitHub committed on 10/13/2016, 10:58:53 PM
Parent: a81d5b4839992b6e494921404deee61709e162bf
Files changed
docs/throughs/flatten.md | changed |
docs/throughs/flatten.md | ||
---|---|---|
@@ -1,8 +1,12 @@ | ||
1 | 1 | # pull-stream/throughs/flatten |
2 | 2 | |
3 | -`flatten = require('pull-stream/throughs/flatten')` | |
3 | +## usage | |
4 | +### `flatten = require('pull-stream/throughs/flatten')` | |
5 | +### `flatten(streams)` | |
6 | +Turn a stream of streams or a stream of arrays into a stream of their items, (undoes group). | |
4 | 7 | |
8 | + | |
5 | 9 | ## example |
6 | 10 | ```js |
7 | 11 | test('flatten arrays', function (t) { |
8 | 12 | pull( |
@@ -35,10 +39,4 @@ | ||
35 | 39 | ) |
36 | 40 | |
37 | 41 | }) |
38 | 42 | ``` |
39 | - | |
40 | -## usage | |
41 | - | |
42 | -### `flatten(streams)` | |
43 | - | |
44 | -Turn a stream of streams or a stream of arrays into a stream of their items, (undoes group). |
Built with git-ssb-web