{"action":"closed","issue":{"url":"https://api.github.com/repos/gulpjs/gulp/issues/1731","repository_url":"https://api.github.com/repos/gulpjs/gulp","labels_url":"https://api.github.com/repos/gulpjs/gulp/issues/1731/labels{/name}","comments_url":"https://api.github.com/repos/gulpjs/gulp/issues/1731/comments","events_url":"https://api.github.com/repos/gulpjs/gulp/issues/1731/events","html_url":"https://github.com/gulpjs/gulp/issues/1731","id":166852940,"number":1731,"title":"Please document gulp.src() (vinyl-fs#src) `followSymlinks` option for gulp@4","user":{"login":"jmm","id":129203,"avatar_url":"https://avatars.githubusercontent.com/u/129203?v=3","gravatar_id":"","url":"https://api.github.com/users/jmm","html_url":"https://github.com/jmm","followers_url":"https://api.github.com/users/jmm/followers","following_url":"https://api.github.com/users/jmm/following{/other_user}","gists_url":"https://api.github.com/users/jmm/gists{/gist_id}","starred_url":"https://api.github.com/users/jmm/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jmm/subscriptions","organizations_url":"https://api.github.com/users/jmm/orgs","repos_url":"https://api.github.com/users/jmm/repos","events_url":"https://api.github.com/users/jmm/events{/privacy}","received_events_url":"https://api.github.com/users/jmm/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2016-07-21T15:45:59Z","updated_at":"2016-07-21T21:03:11Z","closed_at":"2016-07-21T21:03:11Z","body":"In actuality `gulp.src` is `require(\"vinyl-fs\").src` and there's documentation of some of its options duplicated / excluded, respectively. I mention it in case that can be the public API and it makes more sense to eliminate most of the duplication, link to the `vinyl-fs` docs, and just include notes that are relevant in the context of `gulp` if applicable. Like:\r\n\r\n> **Note:** Plugins might not implement support for streams.\r\n\r\nBut please document at least `followSymlinks` one way or the other.\r\n\r\nRelated:\r\n\r\n  * https://github.com/gulpjs/gulp/issues/1427\r\n  * https://github.com/gulpjs/gulp/issues/1273\r\n  * https://github.com/gulpjs/vinyl-fs/pull/85"}}
{"actor":{"display_login":"phated"}}