Skip to content

docs: jsdoc + travis auto build to gh-pages.#127

Merged
silvolu merged 1 commit into
googleapis:masterfrom
stephenplusplus:docs
Aug 27, 2014
Merged

docs: jsdoc + travis auto build to gh-pages.#127
silvolu merged 1 commit into
googleapis:masterfrom
stephenplusplus:docs

Conversation

@stephenplusplus

Copy link
Copy Markdown
Contributor

@stephenplusplus

Copy link
Copy Markdown
Contributor Author

Let me know if/when this is merge-worthy, and I'll do a rebase and rebuild of the docs so we're current.

@silvolu

silvolu commented Aug 26, 2014

Copy link
Copy Markdown
Contributor

Oh, I thought it was still WIP from the commit message :)

Looks good to me, please go forward. I'll then make some tweaks that we'll discuss later!

@stephenplusplus stephenplusplus force-pushed the docs branch 2 times, most recently from cc6dfcc to d27dfad Compare August 26, 2014 17:21
@stephenplusplus

Copy link
Copy Markdown
Contributor Author

Re-built :)

@rakyll

rakyll commented Aug 26, 2014

Copy link
Copy Markdown
Contributor

Is it possible to remove TODOs and private types/members/methods from docs? We should generate docs only for user-facing stuff.

@stephenplusplus

Copy link
Copy Markdown
Contributor Author

Poll time! Do you think the docs should be:

var dataset = new Dataset(){};

or a real use case:

var gcloud = require('gcloud');
var dataset = new gcloud.datastore.Dataset({});

?

@silvolu

silvolu commented Aug 26, 2014

Copy link
Copy Markdown
Contributor

I vote real use case.

@rakyll

rakyll commented Aug 26, 2014

Copy link
Copy Markdown
Contributor

I vote for the real use case too. Maybe we don't need to mention var gcloud = require('gcloud') each time.

@stephenplusplus

Copy link
Copy Markdown
Contributor Author

Holy moly, the big PR is updated! http://stephenplusplus.github.io/gcloud-node/ for a preview.

@stephenplusplus stephenplusplus changed the title docs: jsdoc + jsdoc2md + travis auto build to gh-pages. docs: jsdoc + travis auto build to gh-pages. Aug 27, 2014
@rakyll

rakyll commented Aug 27, 2014

Copy link
Copy Markdown
Contributor

Looks great!

@silvolu

silvolu commented Aug 27, 2014

Copy link
Copy Markdown
Contributor

Great, thanks!

silvolu added a commit that referenced this pull request Aug 27, 2014
docs: jsdoc + travis auto build to gh-pages.
@silvolu silvolu merged commit adb85ad into googleapis:master Aug 27, 2014
chingor13 pushed a commit that referenced this pull request Aug 22, 2022
sofisl pushed a commit that referenced this pull request Sep 15, 2022
sofisl pushed a commit that referenced this pull request Oct 11, 2022
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.

3 participants