Skip to content

Commit 383b4e5

Browse files
committed
Merge pull request #280 from stephenplusplus/spp--docs-link-fix
docs: fix links. fixes #279
2 parents a551685 + e5b1b6c commit 383b4e5

File tree

10 files changed

+44
-51
lines changed

10 files changed

+44
-51
lines changed

lib/bigquery/dataset.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,7 @@ function Dataset(bigQuery, id) {
6262
* "timestamp". If the type is omitted, it is assumed to be "string".
6363
* Example: "name:string, age:integer". Schemas can also be specified as a
6464
* JSON array of fields, which allows for nested and repeated fields. See
65-
* a [Table resource]{@link http://goo.gl/sl8Dmg} for more detailed
66-
* information.
65+
* a [Table resource](http://goo.gl/sl8Dmg) for more detailed information.
6766
* @param {function} callback - The callback function.
6867
*
6968
* @example

lib/bigquery/index.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ var SCOPES = ['https://www.googleapis.com/auth/bigquery'];
102102
* //-
103103
* // In the following examples from this page and the other modules (Dataset,
104104
* // Table, etc.), we are going to be using a dataset from
105-
* // [data.gov]{@link http://goo.gl/f2SXcb} of higher education institutions.
105+
* // [data.gov](http://goo.gl/f2SXcb) of higher education institutions.
106106
* //
107107
* // We will create a table with the correct schema, import the public CSV file
108108
* // into that table, and query it for data.
@@ -453,9 +453,9 @@ BigQuery.prototype.query = function(options, callback) {
453453
* check on the status of the job.
454454
*
455455
* @param {object|string} options - The configuration object. This must be in
456-
* the format of the [`configuration.query`]{@link http://goo.gl/wRpHvR}
457-
* property of a Jobs resource. If a string is provided, this is used as the
458-
* query string, and all other options are defaulted.
456+
* the format of the [`configuration.query`](http://goo.gl/wRpHvR) property
457+
* of a Jobs resource. If a string is provided, this is used as the query
458+
* string, and all other options are defaulted.
459459
* @param {module:bigquery/table=} options.destination - The table to save the
460460
* query's results to. If omitted, a new table will be created.
461461
* @param {string} options.query - A query string, following the BigQuery query

lib/bigquery/table.js

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,7 @@ Table.mergeSchemaWithRows_ = function(schema, rows) {
118118
* @param {module:bigquery/table} destination - The destination table.
119119
* @param {object=} metadata - Metadata to set with the copy operation. The
120120
* metadata object should be in the format of the
121-
* [`configuration.copy`]{@link http://goo.gl/dKWIyS} property of a Jobs
122-
* resource.
121+
* [`configuration.copy`](http://goo.gl/dKWIyS) property of a Jobs resource.
123122
* @param {function} callback - The callback function.
124123
*
125124
* @throws {Error} If a destination other than a Table object is provided.
@@ -128,7 +127,7 @@ Table.mergeSchemaWithRows_ = function(schema, rows) {
128127
* table.copy(dataset.table('institution_data'), function(err, job) {});
129128
*
130129
* //-
131-
* // See the [`configuration.copy`]{@link http://goo.gl/dKWIyS} object for all
130+
* // See the [`configuration.copy`](http://goo.gl/dKWIyS) object for all
132131
* // available options.
133132
* //-
134133
* var metadata = {
@@ -228,8 +227,8 @@ Table.prototype.createReadStream = function() {
228227
*
229228
* @param {string|object=} metadata - Metadata to set with the load operation.
230229
* The metadata object should be in the format of the
231-
* [`configuration.load`]{@link http://goo.gl/BVcXk4} property of a Jobs
232-
* resource. If a string is given, it will be used as the filetype.
230+
* [`configuration.load`](http://goo.gl/BVcXk4) property of a Jobs resource.
231+
* If a string is given, it will be used as the filetype.
233232
* @return {WriteStream}
234233
*
235234
* @throws {Error} If source format isn't recognized.
@@ -569,8 +568,7 @@ Table.prototype.getRows = function(options, callback) {
569568
* @param {string|module:storage/file} source - The source file to import.
570569
* @param {object=} metadata - Metadata to set with the load operation. The
571570
* metadata object should be in the format of the
572-
* [`configuration.load`]{@link http://goo.gl/BVcXk4} property of a Jobs
573-
* resource.
571+
* [`configuration.load`](http://goo.gl/BVcXk4) property of a Jobs resource.
574572
* @param {function} callback - The callback function.
575573
*
576574
* @throws {Error} If the source isn't a string file name or a File instance.
@@ -583,7 +581,7 @@ Table.prototype.getRows = function(options, callback) {
583581
*
584582
* //-
585583
* // You may also pass in metadata in the format of a Jobs resource. See
586-
* // {@link http://goo.gl/BVcXk4} for a full list of supported values.
584+
* // (http://goo.gl/BVcXk4) for a full list of supported values.
587585
* //-
588586
* var metadata = {
589587
* encoding: 'ISO-8859-1',
@@ -789,8 +787,7 @@ Table.prototype.query = function(query, callback) {
789787
* "timestamp". If the type is omitted, it is assumed to be "string".
790788
* Example: "name:string, age:integer". Schemas can also be specified as a
791789
* JSON array of fields, which allows for nested and repeated fields. See
792-
* a [Table resource]{@link http://goo.gl/sl8Dmg} for more detailed
793-
* information.
790+
* a [Table resource](http://goo.gl/sl8Dmg) for more detailed information.
794791
* @param {function} callback - The callback function.
795792
*/
796793
Table.prototype.setMetadata = function(metadata, callback) {

lib/datastore/dataset.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ var SCOPES = [
7070

7171
/**
7272
* Interact with a dataset from the
73-
* [Google Cloud Datastore]{@link https://developers.google.com/datastore/}.
73+
* [Google Cloud Datastore](https://developers.google.com/datastore/).
7474
*
7575
* @constructor
7676
* @alias module:datastore/dataset
@@ -155,7 +155,7 @@ Dataset.prototype.key = function(options) {
155155
* Create a query from the current dataset to query the specified kinds, scoped
156156
* to the namespace provided at the initialization of the dataset.
157157
*
158-
* *Dataset query reference: {@link http://goo.gl/Cag0r6}*
158+
* *Dataset query reference: (http://goo.gl/Cag0r6)*
159159
*
160160
* @borrows {module:datastore/query} as createQuery
161161
* @see {module:datastore/query}

lib/datastore/query.js

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ var util = require('../common/util.js');
3535
* {@linkcode module:datastore/dataset#createQuery} and run via
3636
* {@linkcode module:datastore/dataset#runQuery}.**
3737
*
38-
* *Reference: {@link http://goo.gl/Cag0r6}*
38+
* *Reference: (http://goo.gl/Cag0r6)*
3939
*
4040
* @constructor
4141
* @alias module:datastore/query
@@ -82,7 +82,7 @@ function Query(namespace, kinds) {
8282
*
8383
* *To filter by ancestors, see {@linkcode module:datastore/query#hasAncestor}.*
8484
*
85-
* *Reference: {@link http://goo.gl/ENCx7e}*
85+
* *Reference: (http://goo.gl/ENCx7e)*
8686
*
8787
* @param {string} filter - Property + Operator (=, <, >, <=, >=).
8888
* @param {*} value - Value to compare property to.
@@ -116,7 +116,7 @@ Query.prototype.filter = function(filter, value) {
116116
/**
117117
* Filter a query by ancestors.
118118
*
119-
* *Reference: {@link http://goo.gl/1qfpkZ}*
119+
* *Reference: (http://goo.gl/1qfpkZ)*
120120
*
121121
* @param {Key} key - Key object to filter by.
122122
* @return {module:datastore/query}
@@ -134,7 +134,7 @@ Query.prototype.hasAncestor = function(key) {
134134
* Sort the results by a property name in ascending or descending order. By
135135
* default, an ascending sort order will be used.
136136
*
137-
* *Reference: {@link http://goo.gl/mfegFR}*
137+
* *Reference: (http://goo.gl/mfegFR)*
138138
*
139139
* @param {string} property - Optional operator (+, -) and property to order by.
140140
* @return {module:datastore/query}
@@ -176,7 +176,7 @@ Query.prototype.groupBy = function(fieldNames) {
176176
/**
177177
* Retrieve only select properties from the matched entities.
178178
*
179-
* *Reference: [Projection Queries]{@link http://goo.gl/EfsrJl}*
179+
* *[Reference](http://goo.gl/EfsrJl).*
180180
*
181181
* @param {array} fieldNames - Properties to return from the matched entities.
182182
* @return {module:datastore/query}
@@ -194,7 +194,7 @@ Query.prototype.select = function(fieldNames) {
194194
/**
195195
* Set a starting cursor to a query.
196196
*
197-
* *Reference: {@link http://goo.gl/WuTGRI}*
197+
* *[Reference](http://goo.gl/WuTGRI).*
198198
*
199199
* @param {string} cursorToken - The starting cursor token.
200200
* @return {module:datastore/query}
@@ -214,7 +214,7 @@ Query.prototype.start = function(start) {
214214
/**
215215
* Set an ending cursor to a query.
216216
*
217-
* *Reference: {@link http://goo.gl/WuTGRI}*
217+
* *Reference: (http://goo.gl/WuTGRI)*
218218
*
219219
* @param {string} cursorToken - The ending cursor token.
220220
* @return {module:datastore/query}
@@ -234,7 +234,7 @@ Query.prototype.end = function(end) {
234234
/**
235235
* Set a limit on a query.
236236
*
237-
* *Reference: {@link http://goo.gl/f0VZ0n}*
237+
* *Reference: (http://goo.gl/f0VZ0n)*
238238
*
239239
* @param {number} n - The number of results to limit the query to.
240240
* @return {module:datastore/query}
@@ -252,7 +252,7 @@ Query.prototype.limit = function(n) {
252252
/**
253253
* Set an offset on a query.
254254
*
255-
* *Reference: {@link http://goo.gl/f0VZ0n}*
255+
* *Reference: (http://goo.gl/f0VZ0n)*
256256
*
257257
* @param {number} n - The offset to start from after the start cursor.
258258
* @return {module:datastore/query}

lib/datastore/transaction.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ var DatastoreRequest = require('./request.js');
4747
* {@linkcode module:datastore/dataset}. When you need to run a transactional
4848
* operation, use {@linkcode module:datastore/dataset#runInTransaction}.
4949
*
50-
* *Reference: {@link http://goo.gl/n4oSjt}*
50+
* *[Reference](http://goo.gl/n4oSjt).*
5151
*
5252
* @constructor
5353
* @alias module:datastore/transaction

lib/index.js

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -122,9 +122,9 @@ function gcloud(config) {
122122

123123
/**
124124
* Analyze Big Data in the cloud with
125-
* [Google BigQuery]{@link https://cloud.google.com/bigquery}. Run fast,
126-
* SQL-like queries against multi-terabyte datasets in seconds. Scalable and
127-
* easy to use, BigQuery gives you real-time insights about your data.
125+
* [Google BigQuery](https://cloud.google.com/bigquery). Run fast, SQL-like
126+
* queries against multi-terabyte datasets in seconds. Scalable and easy to use,
127+
* BigQuery gives you real-time insights about your data.
128128
*
129129
* @type {module:bigquery}
130130
*
@@ -140,10 +140,10 @@ function gcloud(config) {
140140
gcloud.bigquery = BigQuery;
141141

142142
/**
143-
* [Google Cloud Datastore]{@link https://developers.google.com/datastore/} is
144-
* a fully managed, schemaless database for storing non-relational data. Use
145-
* this object to create a Dataset to interact with your data, an "Int", and a
146-
* "Double" representation.
143+
* [Google Cloud Datastore](https://developers.google.com/datastore/) is a fully
144+
* managed, schemaless database for storing non-relational data. Use this object
145+
* to create a Dataset to interact with your data, an "Int", and a "Double"
146+
* representation.
147147
*
148148
* @type {module:datastore}
149149
*
@@ -162,16 +162,15 @@ gcloud.datastore = Datastore;
162162
/**
163163
* **Experimental**
164164
*
165-
* [Google Cloud Pub/Sub]{@link https://developers.google.com/pubsub/overview}
166-
* is a reliable, many-to-many, asynchronous messaging service from Google
167-
* Cloud Platform.
165+
* [Google Cloud Pub/Sub](https://developers.google.com/pubsub/overview) is a
166+
* reliable, many-to-many, asynchronous messaging service from Google Cloud
167+
* Platform.
168168
*
169169
* Note: Google Cloud Pub/Sub API is available as a Limited Preview and the
170170
* client library we provide is currently experimental. The API and/or the
171171
* client might be changed in backward-incompatible ways. This API is not
172172
* subject to any SLA or deprecation policy. Request to be whitelisted to use it
173-
* by filling the
174-
* [Limited Preview application form]{@link http://goo.gl/sO0wTu}.
173+
* by filling the [Limited Preview application form](http://goo.gl/sO0wTu).
175174
*
176175
* @type {module:pubsub}
177176
*
@@ -190,8 +189,7 @@ gcloud.pubsub = function(config) {
190189

191190
/**
192191
* Google Cloud Storage allows you to store data on Google infrastructure.
193-
* Read
194-
* [Google Cloud Storage API docs]{@link https://developers.google.com/storage/}
192+
* Read [Google Cloud Storage API docs](https://developers.google.com/storage/)
195193
* for more information.
196194
*
197195
* @type {module:storage}

lib/pubsub/index.js

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,16 +60,15 @@ var SCOPES = [
6060
];
6161

6262
/**
63-
* [Google Cloud Pub/Sub]{@link https://developers.google.com/pubsub/overview}
64-
* is a reliable, many-to-many, asynchronous messaging service from Google
65-
* Cloud Platform.
63+
* [Google Cloud Pub/Sub](https://developers.google.com/pubsub/overview) is a
64+
* reliable, many-to-many, asynchronous messaging service from Google Cloud
65+
* Platform.
6666
*
6767
* Note: Google Cloud Pub/Sub API is available as a Limited Preview and the
6868
* client library we provide is currently experimental. The API and/or the
6969
* client might be changed in backward-incompatible ways. This API is not
7070
* subject to any SLA or deprecation policy. Request to be whitelisted to use
71-
* it by filling the
72-
* [Limited Preview application form]{@link http://goo.gl/sO0wTu}.
71+
* it by filling the [Limited Preview application form](http://goo.gl/sO0wTu).
7372
*
7473
* @constructor
7574
* @alias module:pubsub

lib/pubsub/subscription.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@ var util = require('../common/util.js');
5454
* - {@linkcode module:pubsub/topic#subscription}
5555
*
5656
* All Subscription objects are instances of an
57-
* [EventEmitter]{@link http://nodejs.org/api/events.html}. The subscription
58-
* will pull for messages automatically as long as there is at least one
59-
* listener assigned for the `message` event.
57+
* [EventEmitter](http://nodejs.org/api/events.html). The subscription will pull
58+
* for messages automatically as long as there is at least one listener assigned
59+
* for the `message` event.
6060
*
6161
* @alias pubsub/subscription
6262
* @constructor

lib/storage/file.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ File.prototype.getMetadata = function(callback) {
323323
/**
324324
* Get a signed URL to allow limited time access to the file.
325325
*
326-
* {@link https://developers.google.com/storage/docs/accesscontrol#Signed-URLs}
326+
* *[Reference](http://goo.gl/LcqhjU).*
327327
*
328328
* @throws {Error} if an expiration timestamp from the past is given.
329329
*

0 commit comments

Comments
 (0)