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

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

Merged
merged 1 commit into from
Aug 27, 2014

Conversation

stephenplusplus
Copy link
Contributor

work in progress

RE: #125

Preview:
JSDoc-rendered HTML: http://stephenplusplus.github.io/gcloud-node

Readme changes: https://github.com/stephenplusplus/gcloud-node/tree/docs

@stephenplusplus
Copy link
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
Copy link
Contributor

silvolu commented Aug 26, 2014

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
Copy link
Contributor Author

Re-built :)

@rakyll
Copy link
Contributor

rakyll commented Aug 26, 2014

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
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
Copy link
Contributor

silvolu commented Aug 26, 2014

I vote real use case.

@rakyll
Copy link
Contributor

rakyll commented Aug 26, 2014

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

@stephenplusplus
Copy link
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
Copy link
Contributor

rakyll commented Aug 27, 2014

Looks great!

@silvolu
Copy link
Contributor

silvolu commented Aug 27, 2014

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
sofisl pushed a commit that referenced this pull request Nov 11, 2022
chore(deps): update dependency mocha to v6

This PR contains the following updates:

| Package | Type | Update | Change | References |
|---|---|---|---|---|
| mocha | devDependencies | major | `^5.2.0` -> `^6.0.0` | [homepage](https://mochajs.org/), [source](https://togithub.com/mochajs/mocha) |

---

### Release Notes

<details>
<summary>mochajs/mocha</summary>

### [`v6.0.0`](https://togithub.com/mochajs/mocha/blob/master/CHANGELOG.md#&#8203;600--2019-02-18)

[Compare Source](https://togithub.com/mochajs/mocha/compare/v5.2.0...v6.0.0)

#### 🎉 Enhancements

-   [#&#8203;3726](https://togithub.com/mochajs/mocha/issues/3726): Add ability to unload files from `require` cache ([**@&#8203;plroebuck**](https://togithub.com/plroebuck))

#### 🐛 Fixes

-   [#&#8203;3737](https://togithub.com/mochajs/mocha/issues/3737): Fix falsy values from options globals ([**@&#8203;plroebuck**](https://togithub.com/plroebuck))
-   [#&#8203;3707](https://togithub.com/mochajs/mocha/issues/3707): Fix encapsulation issues for `Suite#_onlyTests` and `Suite#_onlySuites` ([**@&#8203;vkarpov15**](https://togithub.com/vkarpov15))
-   [#&#8203;3711](https://togithub.com/mochajs/mocha/issues/3711): Fix diagnostic messages dealing with plurality and markup of output ([**@&#8203;plroebuck**](https://togithub.com/plroebuck))
-   [#&#8203;3723](https://togithub.com/mochajs/mocha/issues/3723): Fix "reporter-option" to allow comma-separated options ([**@&#8203;boneskull**](https://togithub.com/boneskull))
-   [#&#8203;3722](https://togithub.com/mochajs/mocha/issues/3722): Fix code quality and performance of `lookupFiles` and `files` ([**@&#8203;plroebuck**](https://togithub.com/plroebuck))
-   [#&#8203;3650](https://togithub.com/mochajs/mocha/issues/3650), [#&#8203;3654](https://togithub.com/mochajs/mocha/issues/3654): Fix noisy error message when no files found ([**@&#8203;craigtaub**](https://togithub.com/craigtaub))
-   [#&#8203;3632](https://togithub.com/mochajs/mocha/issues/3632): Tests having an empty title are no longer confused with the "root" suite ([**@&#8203;juergba**](https://togithub.com/juergba))
-   [#&#8203;3666](https://togithub.com/mochajs/mocha/issues/3666): Fix missing error codes ([**@&#8203;vkarpov15**](https://togithub.com/vkarpov15))
-   [#&#8203;3684](https://togithub.com/mochajs/mocha/issues/3684): Fix exiting problem in Node.js v11.7.0+ ([**@&#8203;addaleax**](https://togithub.com/addaleax))
-   [#&#8203;3691](https://togithub.com/mochajs/mocha/issues/3691): Fix `--delay` (and other boolean options) not working in all cases ([**@&#8203;boneskull**](https://togithub.com/boneskull))
-   [#&#8203;3692](https://togithub.com/mochajs/mocha/issues/3692): Fix invalid command-line argument usage not causing actual errors ([**@&#8203;boneskull**](https://togithub.com/boneskull))
-   [#&#8203;3698](https://togithub.com/mochajs/mocha/issues/3698), [#&#8203;3699](https://togithub.com/mochajs/mocha/issues/3699): Fix debug-related Node.js options not working in all cases ([**@&#8203;boneskull**](https://togithub.com/boneskull))
-   [#&#8203;3700](https://togithub.com/mochajs/mocha/issues/3700): Growl notifications now show the correct number of tests run ([**@&#8203;outsideris**](https://togithub.com/outsideris))
-   [#&#8203;3686](https://togithub.com/mochajs/mocha/issues/3686): Avoid potential ReDoS when diffing large objects ([**@&#8203;cyjake**](https://togithub.com/cyjake))
-   [#&#8203;3715](https://togithub.com/mochajs/mocha/issues/3715): Fix incorrect order of emitted events when used programmatically ([**@&#8203;boneskull**](https://togithub.com/boneskull))
-   [#&#8203;3706](https://togithub.com/mochajs/mocha/issues/3706): Fix regression wherein `--reporter-option`/`--reporter-options` did not support comma-separated key/value pairs ([**@&#8203;boneskull**](https://togithub.com/boneskull))

#### 📖 Documentation

-   [#&#8203;3652](https://togithub.com/mochajs/mocha/issues/3652): Switch from Jekyll to Eleventy ([**@&#8203;Munter**](https://togithub.com/Munter))

#### 🔩 Other

-   [#&#8203;3677](https://togithub.com/mochajs/mocha/issues/3677): Add error objects for createUnsupportedError and createInvalidExceptionError ([**@&#8203;boneskull**](https://togithub.com/boneskull))
-   [#&#8203;3733](https://togithub.com/mochajs/mocha/issues/3733): Removed unnecessary processing in post-processing hook ([**@&#8203;wanseob**](https://togithub.com/wanseob))
-   [#&#8203;3730](https://togithub.com/mochajs/mocha/issues/3730): Update nyc to latest version ([**@&#8203;coreyfarrell**](https://togithub.com/coreyfarrell))
-   [#&#8203;3648](https://togithub.com/mochajs/mocha/issues/3648), [#&#8203;3680](https://togithub.com/mochajs/mocha/issues/3680): Fixes to support latest versions of [unexpected](https://npm.im/unexpected) and [unexpected-sinon](https://npm.im/unexpected-sinon) ([**@&#8203;sunesimonsen**](https://togithub.com/sunesimonsen))
-   [#&#8203;3638](https://togithub.com/mochajs/mocha/issues/3638): Add meta tag to site ([**@&#8203;MartijnCuppens**](https://togithub.com/MartijnCuppens))
-   [#&#8203;3653](https://togithub.com/mochajs/mocha/issues/3653): Fix parts of test suite failing to run on Windows ([**@&#8203;boneskull**](https://togithub.com/boneskull))

</details>

---

### Renovate configuration

:date: **Schedule**: "after 9am and before 3pm" (UTC).

:vertical_traffic_light: **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

:recycle: **Rebasing**: Whenever PR is stale, or if you modify the PR title to begin with "`rebase!`".

:no_bell: **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- renovate-rebase -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://togithub.com/marketplace/renovate). View repository job log [here](https://renovatebot.com/dashboard#googleapis/nodejs-kms).

#127 automerged by dpebot
sofisl pushed a commit that referenced this pull request Nov 11, 2022
sofisl pushed a commit that referenced this pull request Nov 11, 2022
sofisl pushed a commit that referenced this pull request Nov 11, 2022
fix: use google-gax v3.3.0
Source-Link: googleapis/synthtool@c73d112
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-nodejs:latest@sha256:b15a6f06cc06dcffa11e1bebdf1a74b6775a134aac24a0f86f51ddf728eb373e
sofisl pushed a commit that referenced this pull request Nov 11, 2022
#127)

* build(node): add feat in node post-processor to add client library version number in snippet metadata

Co-authored-by: Benjamin E. Coe <bencoe@google.com>
Source-Link: googleapis/synthtool@d337b88
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-nodejs:latest@sha256:d106724ad2a96daa1b8d88de101ba50bdb30b8df62ffa0aa2b451d93b4556641
sofisl pushed a commit that referenced this pull request Nov 11, 2022
🤖 I have created a release *beep* *boop*
---


## [2.0.3](https://togithub.com/googleapis/nodejs-org-policy/compare/v2.0.2...v2.0.3) (2022-11-11)


### Bug Fixes

* Allow passing gax instance to client constructor ([#126](https://togithub.com/googleapis/nodejs-org-policy/issues/126)) ([c7147d4](https://togithub.com/googleapis/nodejs-org-policy/commit/c7147d40a9ed114ec42997d49c2f5dfcff948aad))
* **deps:** Use google-gax v3.5.2 ([#134](https://togithub.com/googleapis/nodejs-org-policy/issues/134)) ([0f1bfb0](https://togithub.com/googleapis/nodejs-org-policy/commit/0f1bfb0007ade736c2ec91f32ff187c80b2d6761))
* Do not import the whole google-gax from proto JS ([#1553](https://togithub.com/googleapis/nodejs-org-policy/issues/1553)) ([#125](https://togithub.com/googleapis/nodejs-org-policy/issues/125)) ([068b0a5](https://togithub.com/googleapis/nodejs-org-policy/commit/068b0a55fe805cedab9e66f62071c8be56f465ed))
* Preserve default values in x-goog-request-params header ([#128](https://togithub.com/googleapis/nodejs-org-policy/issues/128)) ([3f80014](https://togithub.com/googleapis/nodejs-org-policy/commit/3f80014a3c75311555df6cfde8470ae1f72a686f))
* Regenerated protos JS and TS definitions ([#137](https://togithub.com/googleapis/nodejs-org-policy/issues/137)) ([1606459](https://togithub.com/googleapis/nodejs-org-policy/commit/1606459c847f2ed945dccc8e43d57d273fac7ea9))
* use google-gax v3.3.0 ([068b0a5](https://togithub.com/googleapis/nodejs-org-policy/commit/068b0a55fe805cedab9e66f62071c8be56f465ed))

---
This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).
sofisl pushed a commit that referenced this pull request Nov 16, 2022
[![WhiteSource Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [@types/mocha](https://togithub.com/DefinitelyTyped/DefinitelyTyped) | [`^8.0.4` -> `^9.0.0`](https://renovatebot.com/diffs/npm/@types%2fmocha/8.2.3/9.1.1) | [![age](https://badges.renovateapi.com/packages/npm/@types%2fmocha/9.1.1/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/@types%2fmocha/9.1.1/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/@types%2fmocha/9.1.1/compatibility-slim/8.2.3)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/@types%2fmocha/9.1.1/confidence-slim/8.2.3)](https://docs.renovatebot.com/merge-confidence/) |

---

### Configuration

📅 **Schedule**: "after 9am and before 3pm" (UTC).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.

---

This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/nodejs-managed-identities).
sofisl pushed a commit that referenced this pull request Nov 16, 2022
* [CHANGE ME] Re-generated  to pick up changes in the API or client library generator.

* test: update sample test to pass

Co-authored-by: Alexander Fenster <github@fenster.name>
sofisl pushed a commit that referenced this pull request Nov 16, 2022
Source-Link: googleapis/synthtool@6981da4
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-nodejs:latest@sha256:3563b6b264989c4f5aa31a3682e4df36c95756cfef275d3201508947cbfc511e

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
sofisl pushed a commit that referenced this pull request Nov 17, 2022
sofisl pushed a commit that referenced this pull request Nov 30, 2022
This PR includes changes from googleapis/gapic-generator-typescript#317
that will move the asynchronous initialization and authentication from the client constructor
to an `initialize()` method. This method will be automatically called when the first RPC call
is performed.

The client library usage has not changed, there is no need to update any code.

If you want to make sure the client is authenticated _before_ the first RPC call, you can do
```js
await client.initialize();
```
manually before calling any client method.
sofisl pushed a commit that referenced this pull request Jan 24, 2023
sofisl pushed a commit that referenced this pull request Jan 25, 2023
sofisl pushed a commit that referenced this pull request Sep 13, 2023
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.

None yet

3 participants