Skip to content

Docs: Update usage & add API documentation (closes #24)#29

Merged
phated merged 1 commit intomasterfrom
docs
Jun 18, 2017
Merged

Docs: Update usage & add API documentation (closes #24)#29
phated merged 1 commit intomasterfrom
docs

Conversation

@phated
Copy link
Member

@phated phated commented Jun 18, 2017

@contra @stevelacy Can you guys review this? Maybe @robinvenneman @nmccready if you have bandwidth.


// The 2nd argument can be given as a path string
sourcemap.write(file, './maps', function(err, updatedFile, sourcemapFile) {
// sourcemapFile will be a Vinyl file to be written to some location
Copy link

@nmccready nmccready Jun 18, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. However, you might want to move section 15-24 to after line 58. I recommend this as the below explanations are much more thorough. The below makes it clear that all the files are Vinyl file objects where only line 22 above makes that explicit.

Anyway, if you like it the way it is then merge away.

@phated

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking a look. Our standard gulp-org docs template has the simplified usage first followed by the detailed API docs, so I'll probably keep it in this order.

@phated phated merged commit 75a64b9 into master Jun 18, 2017
@phated phated deleted the docs branch June 18, 2017 20:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants