Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve publish API #8

Merged
merged 2 commits into from
Jun 29, 2014
Merged

Improve publish API #8

merged 2 commits into from
Jun 29, 2014

Conversation

markdalgleish
Copy link
Collaborator

This pull request has a few changes:

  • Base path is now a required parameter up front, with no default value.
  • The options parameter is now optional, allowing the module to be used like this: ghpages.publish(basePath, callback)
  • I've removed the JSDoc comments since the publish function is now variadic and I'm not sure it's worth the trouble. Happy to be convinced otherwise :)

This allows the module to be used like so:
ghpages.deploy(basePath, callback)
@markdalgleish
Copy link
Collaborator Author

Any thoughts on this? This is probably the final thing I'd need for the next version to be published to npm.

@tschaub
Copy link
Owner

tschaub commented Jun 29, 2014

Looks good to me @markdalgleish.

tschaub added a commit that referenced this pull request Jun 29, 2014
Make base path required and options optional.
@tschaub tschaub merged commit 18614ee into tschaub:master Jun 29, 2014
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