Merge pull request gulpjs#674 from pkozlowski-opensource/issue673

document the return value of gulp.src
budhin22 · Sep 8, 2014 · fb8c780 · fb8c780
2 parents 16cc9b3 + 17af7eb
commit fb8c780
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/docs/API.md b/docs/API.md
@@ -2,7 +2,7 @@
 
 ### gulp.src(globs[, options])
 
-Takes a glob and represents a file structure. Can be piped to plugins.
+Takes a glob and represents a file structure. Returns a [stream](http://nodejs.org/api/stream.html) of [Vinyl files](https://github.com/wearefractal/vinyl-fs) that can be [piped](http://nodejs.org/api/stream.html#stream_readable_pipe_destination_options) to plugins.
 
 ```js
 gulp.src('client/templates/*.jade')