Skip to content

Commit 0e31d81

Browse files
stephenplusplusstephenplusplus
committed
Supply module instantiation code to each type
1 parent 66ac068 commit 0e31d81

58 files changed

Lines changed: 226 additions & 663 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
"docs": "node ./scripts/docs/packages.js",
3030
"bundle": "node ./scripts/docs/bundle.js",
3131
"lint": "jshint scripts/ packages/ system-test/ test/ && jscs packages/ system-test/ test/",
32-
"test": "npm run docs && mocha test/docs.js packages/*/test/*.js",
32+
"test": "npm run docs && npm run bundle && mocha test/docs.js packages/*/test/*.js",
3333
"system-test": "mocha packages/*/system-test/*.js --no-timeouts --bail",
3434
"cover": "istanbul cover _mocha --report lcovonly -- --no-timeouts --bail packages/*/test/*.js -R spec",
3535
"coveralls": "npm run cover && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage"

‎packages/bigquery/src/dataset.js‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,6 @@ var Table = require('./table.js');
4444
* @constructor
4545
*
4646
* @example
47-
* var gcloud = require('google-cloud');
48-
*
49-
* var bigquery = gcloud.bigquery({
50-
* keyFilename: '/path/to/keyfile.json',
51-
* projectId: 'grape-spaceship-123'
52-
* });
5347
* var dataset = bigquery.dataset('institutions');
5448
*/
5549
function Dataset(bigQuery, id) {

‎packages/bigquery/src/index.js‎

Lines changed: 7 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -46,39 +46,19 @@ var Table = require('./table.js');
4646
var PKG = require('../package.json');
4747

4848
/**
49-
* The examples below will demonstrate the different usage patterns your app may
50-
* need to support to retrieve a BigQuery object.
49+
* In the following examples from this page and the other modules (`Dataset`,
50+
* `Table`, etc.), we are going to be using a dataset from
51+
* [data.gov](http://goo.gl/f2SXcb) of higher education institutions.
52+
*
53+
* We will create a table with the correct schema, import the public CSV file
54+
* into that table, and query it for data.
5155
*
5256
* @alias module:bigquery
5357
* @constructor
5458
*
55-
* @classdesc
56-
* The object returned from `gcloud.bigquery` gives you complete access to and
57-
* control of your BigQuery datasets. You can work with existing ones, by using
58-
* the `dataset` method, or create new ones with `createDataset`.
59-
*
60-
* To learn more about BigQuery, see
61-
* [What is BigQuery?](https://cloud.google.com/bigquery/what-is-bigquery)
59+
* @resource [What is BigQuery?]{@link https://cloud.google.com/bigquery/what-is-bigquery}
6260
*
6361
* @param {object} options - [Configuration object](#/docs).
64-
*
65-
* @example
66-
* var gcloud = require('google-cloud')({
67-
* keyFilename: '/path/to/keyfile.json',
68-
* projectId: 'my-project'
69-
* });
70-
*
71-
* var bigquery = gcloud.bigquery();
72-
*
73-
* //-
74-
* // In the following examples from this page and the other modules (Dataset,
75-
* // Table, etc.), we are going to be using a dataset from
76-
* // <a href="http://goo.gl/f2SXcb">data.gov</a> of higher education
77-
* // institutions.
78-
* //
79-
* // We will create a table with the correct schema, import the public CSV
80-
* // file into that table, and query it for data.
81-
* //-
8262
*/
8363
function BigQuery(options) {
8464
if (!(this instanceof BigQuery)) {

‎packages/bigquery/src/job.js‎

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,6 @@ var modelo = require('modelo');
2929
*
3030
* @param {module:bigquery} bigQuery - BigQuery instance.
3131
* @param {string} id - The ID of the job.
32-
*
33-
* @example
34-
* var bigquery = gcloud.bigquery({ projectId: 'grape-spaceship-123' });
35-
* var Job = require('gcloud/lib/bigquery/job');
36-
* var job = new Job(bigquery, 'job-id');
3732
*/
3833
/**
3934
* Job objects are returned from various places in the BigQuery API:
@@ -54,13 +49,6 @@ var modelo = require('modelo');
5449
* @constructor
5550
*
5651
* @example
57-
* var gcloud = require('google-cloud')({
58-
* keyFilename: '/path/to/keyfile.json',
59-
* projectId: 'grape-spaceship-123'
60-
* });
61-
*
62-
* var bigquery = gcloud.bigquery();
63-
*
6452
* var job = bigquery.job('job-id');
6553
*
6654
* //-

‎packages/bigquery/src/table.js‎

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,6 @@ var FORMATS = {
4848
*
4949
* @param {module:bigquery/dataset} dataset - Dataset instance.
5050
* @param {string} id - The ID of the table.
51-
*
52-
* @example
53-
* var bigquery = gcloud.bigquery({ projectId: 'grape-spaceship-123' });
54-
* var Dataset = require('gcloud/lib/bigquery/dataset');
55-
* var dataset = new Dataset(bigquery, 'dataset-id');
56-
* var Table = require('gcloud/lib/bigquery/table');
57-
* var table = new Table(dataset, 'table-id');
5851
*/
5952
/**
6053
* Table objects are returned by methods such as
@@ -65,13 +58,6 @@ var FORMATS = {
6558
* @constructor
6659
*
6760
* @example
68-
* var gcloud = require('google-cloud')({
69-
* keyFilename: '/path/to/keyfile.json',
70-
* projectId: 'grape-spaceship-123'
71-
* });
72-
*
73-
* var bigquery = gcloud.bigquery();
74-
*
7561
* var dataset = bigquery.dataset('my-dataset');
7662
*
7763
* var table = dataset.table('my-table');
@@ -473,7 +459,7 @@ Table.prototype.createWriteStream = function(metadata) {
473459
* @throws {Error} If destination format isn't recongized.
474460
*
475461
* @example
476-
* var gcs = gcloud.storage({
462+
* var gcs = require('@google-cloud/storage')({
477463
* projectId: 'grape-spaceship-123'
478464
* });
479465
* var exportedFile = gcs.bucket('institutions').file('2014.csv');

‎packages/bigtable/src/family.js‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,6 @@ var FamilyError = createErrorClass('FamilyError', function(name) {
4040
* @alias module:bigtable/family
4141
*
4242
* @example
43-
* var gcloud = require('google-cloud');
44-
*
45-
* var bigtable = gcloud.bigtable({
46-
* keyFilename: '/path/to/keyfile.json',
47-
* projectId: 'grape-spaceship-123',
48-
* cluster: 'gcloud-node',
49-
* zone: 'us-central1-b'
50-
* });
51-
*
5243
* var table = bigtable.table('prezzy');
5344
* var family = table.family('follows');
5445
*/

‎packages/bigtable/src/index.js‎

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,11 @@ var Table = require('./table.js');
4242
var PKG = require('../package.json');
4343

4444
/**
45-
* Interact with
46-
* [Google Cloud Bigtable](https://cloud.google.com/bigtable/).
47-
*
48-
* @constructor
4945
* @alias module:bigtable
50-
*
51-
* @classdesc
52-
* The `gcloud.bigtable` object allows you interact with Google Cloud Bigtable.
53-
*
54-
* To learn more about Bigtable, read the
55-
* [Google Cloud Bigtable Concepts Overview](https://cloud.google.com/bigtable/docs/concepts)
46+
* @constructor
5647
*
5748
* @resource [Creating a Cloud Bigtable Cluster]{@link https://cloud.google.com/bigtable/docs/creating-compute-instance}
49+
* @resource [Google Cloud Bigtable Concepts Overview]{@link https://cloud.google.com/bigtable/docs/concepts}
5850
*
5951
* @throws {error} If a cluster is not provided.
6052
* @throws {error} If a zone is not provided.
@@ -64,17 +56,6 @@ var PKG = require('../package.json');
6456
* @param {string|module:compute/zone} options.zone - The zone in which your
6557
* cluster resides.
6658
*
67-
* @example
68-
* var gcloud = require('google-cloud')({
69-
* keyFilename: '/path/to/keyfile.json',
70-
* projectId: 'my-project'
71-
* });
72-
*
73-
* var bigtable = gcloud.bigtable({
74-
* zone: 'us-central1-b',
75-
* cluster: 'gcloud-node'
76-
* });
77-
*
7859
* //-
7960
* // <h3>Creating a Cluster</h3>
8061
* //

‎packages/bigtable/src/row.js‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,15 +60,6 @@ var RowError = createErrorClass('RowError', function(row) {
6060
* @alias module:bigtable/row
6161
*
6262
* @example
63-
* var gcloud = require('google-cloud');
64-
*
65-
* var bigtable = gcloud.bigtable({
66-
* keyFilename: '/path/to/keyfile.json',
67-
* projectId: 'grape-spaceship-123',
68-
* cluster: 'gcloud-node',
69-
* zone: 'us-central1-b'
70-
* });
71-
*
7263
* var table = bigtable.table('prezzy');
7364
* var row = table.row('gwashington');
7465
*/

‎packages/bigtable/src/table.js‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -63,15 +63,6 @@ var Row = require('./row.js');
6363
* @param {string} name - Name of the table.
6464
*
6565
* @example
66-
* var gcloud = require('google-cloud');
67-
*
68-
* var bigtable = gcloud.bigtable({
69-
* keyFilename: '/path/to/keyfile.json',
70-
* projectId: 'grape-spaceship-123',
71-
* cluster: 'gcloud-node',
72-
* zone: 'us-central1-b'
73-
* });
74-
*
7566
* var table = bigtable.table('prezzy');
7667
*/
7768
function Table(bigtable, name) {

‎packages/compute/src/address.js‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,6 @@ var util = require('util');
3939
* @alias module:compute/address
4040
*
4141
* @example
42-
* var gcloud = require('google-cloud')({
43-
* keyFilename: '/path/to/keyfile.json',
44-
* projectId: 'grape-spaceship-123'
45-
* });
46-
*
47-
* var gce = gcloud.compute();
48-
*
4942
* var region = gce.region('region-name');
5043
*
5144
* var address = region.address('address1');

0 commit comments

Comments
 (0)