docs: generate uniform service overviews (#1475)

Author: stephenplusplus

src/index.js

@@ -52,19 +52,11 @@ var Transaction = require('./transaction.js');
 var PKG = require('../package.json');
 
 /**
- * Interact with the
- * [Google Cloud Datastore](https://developers.google.com/datastore/).
- *
  * @constructor
  * @alias module:datastore
  * @mixes module:datastore/request
  *
- * @classdesc
- * The `gcloud.datastore` object allows you to interact with Google Cloud
- * Datastore.
- *
- * To learn more about Datastore, read the
- * [Google Cloud Datastore Concepts Overview](https://cloud.google.com/datastore/docs/concepts/overview)
+ * @resource [Google Cloud Datastore Concepts Overview]{@link https://cloud.google.com/datastore/docs/concepts/overview}
  *
  * @param {object=} options - [Configuration object](#/docs).
  * @param {string=} options.apiEndpoint - Override the default API endpoint used
@@ -73,13 +65,6 @@ var PKG = require('../package.json');
  * @param {string} options.namespace - Namespace to isolate transactions to.
  *
  * @example
- * var gcloud = require('google-cloud')({
- *   projectId: 'grape-spaceship-123',
- *   keyFilename: '/path/to/keyfile.json'
- * });
- *
- * var datastore = gcloud.datastore();
- *
  * //-
  * // <h3>The Datastore Emulator</h3>
  * //
@@ -107,12 +92,7 @@ var PKG = require('../package.json');
  * // Set that environment variable and your localhost Datastore will
  * // automatically be used. You can also pass this address in manually with
  * // `apiEndpoint`.
- * //-
- * var datastore = gcloud.datastore({
- *   apiEndpoint: 'http://localhost:8080'
- * });
- *
- * //-
+ * //
  * // Additionally, `DATASTORE_PROJECT_ID` is recognized. If you have this set,
  * // you don't need to provide a `projectId`.
  * //-
@@ -213,7 +193,7 @@ var PKG = require('../package.json');
  *     };
  *
  *     // Check if  more results may exist.
- *     if (info.moreResults !== gcloud.datastore.NO_MORE_RESULTS) {
+ *     if (info.moreResults !== datastore.NO_MORE_RESULTS) {
  *       frontEndResponse.nextPageCursor = info.endCursor;
  *     }
  *
@@ -360,9 +340,9 @@ modelo.inherits(Datastore, DatastoreRequest, common.GrpcService);
  * @return {object}
  *
  * @example
- * var threeDouble = gcloud.datastore.double(3.0);
+ * var threeDouble = datastore.double(3.0);
  */
-Datastore.double = function(value) {
+Datastore.prototype.double = Datastore.double = function(value) {
   return new entity.Double(value);
 };
 
@@ -380,9 +360,9 @@ Datastore.double = function(value) {
  *   longitude: -74.0447
  * };
  *
- * var geoPoint = gcloud.datastore.geoPoint(coordinates);
+ * var geoPoint = datastore.geoPoint(coordinates);
  */
-Datastore.geoPoint = function(coordindates) {
+Datastore.prototype.geoPoint = Datastore.geoPoint = function(coordindates) {
   return new entity.GeoPoint(coordindates);
 };
 
@@ -393,9 +373,9 @@ Datastore.geoPoint = function(coordindates) {
  * @return {object}
  *
  * @example
- * var sevenInteger = gcloud.datastore.int(7);
+ * var sevenInteger = datastore.int(7);
  */
-Datastore.int = function(value) {
+Datastore.prototype.int = Datastore.int = function(value) {
   return new entity.Int(value);
 };
 
@@ -408,6 +388,7 @@ Datastore.int = function(value) {
  *
  * @type {string}
  */
+Datastore.prototype.MORE_RESULTS_AFTER_CURSOR =
 Datastore.MORE_RESULTS_AFTER_CURSOR = 'MORE_RESULTS_AFTER_CURSOR';
 
 /**
@@ -419,6 +400,7 @@ Datastore.MORE_RESULTS_AFTER_CURSOR = 'MORE_RESULTS_AFTER_CURSOR';
  *
  * @type {string}
  */
+Datastore.prototype.MORE_RESULTS_AFTER_LIMIT =
 Datastore.MORE_RESULTS_AFTER_LIMIT = 'MORE_RESULTS_AFTER_LIMIT';
 
 /**
@@ -430,6 +412,7 @@ Datastore.MORE_RESULTS_AFTER_LIMIT = 'MORE_RESULTS_AFTER_LIMIT';
  *
  * @type {string}
  */
+Datastore.prototype.NO_MORE_RESULTS =
 Datastore.NO_MORE_RESULTS = 'NO_MORE_RESULTS';
 
 /**

src/query.js

@@ -42,12 +42,6 @@ var arrify = require('arrify');
  * @param {string} kind - Kind to query.
  *
  * @example
- * var gcloud = require('google-cloud')({
- *   keyFilename: '/path/to/keyfile.json',
- *   projectId: 'grape-spaceship-123'
- * });
- *
- * var datastore = gcloud.datastore();
  * var query = datastore.createQuery('AnimalNamespace', 'Lion');
  */
 function Query(scope, namespace, kinds) {

src/request.js

@@ -57,15 +57,6 @@ var CONSISTENCY_PROTO_CODE = {
  *
  * Creates requests to the Datastore endpoint. Designed to be inherited by
  * {module:datastore} and {module:datastore/transaction} objects.
- *
- * @example
- * // This is how to create a transaction object directly using this Transaction
- * // class. The following transaction object is created for use in the examples
- * // in this file below.
- * var datastore = gcloud.datastore({ projectId: 'project-id' });
- * var Transaction = require('gcloud/lib/datastore/transaction');
- * var transaction = new Transaction(datastore, 'my-project-id');
- * transaction.id = '1234'; // Give the transaction an ID.
  */
 /**
  * Handle logic for Datastore API operations.
@@ -717,9 +708,9 @@ DatastoreRequest.prototype.runQuery = function(query, options, callback) {
  *   key: key,
  *   data: {
  *     name: 'DonutShack',
- *     rating: gcloud.datastore.int(10),
- *     worth: gcloud.datastore.double(123456.78),
- *     location: gcloud.datastore.geoPoint({
+ *     rating: datastore.int(10),
+ *     worth: datastore.double(123456.78),
+ *     location: datastore.geoPoint({
  *       latitude: 40.6894,
  *       longitude: -74.0447
  *     }),

src/transaction.js

@@ -35,15 +35,6 @@ var Request = require('./request.js');
 /*! Developer Documentation
  *
  * @param {module:datastore} datastore - A Datastore instance.
- *
- * @example
- * // This is how to create a transaction object directly using this Transaction
- * // class. The following transaction object is created for use in the examples
- * // in this file below.
- * var Transaction = gcloud.datastore.Transaction;
- * var datastore = gcloud.datastore({ projectId: 'project-id' });
- * var transaction = new Transaction(datastore, 'my-project-id');
- * transaction.id = '1234'; // Give the transaction an ID.
  */
 /**
  * A transaction is a set of Datastore operations on one or more entities. Each
@@ -58,12 +49,6 @@ var Request = require('./request.js');
  * @mixes module:datastore/request
  *
  * @example
- * var gcloud = require('google-cloud');
- * var datastore = gcloud.datastore({
- *   projectId: 'my-project',
- *   keyFilename: '/path/to/keyfile.json'
- * });
- *
  * var transaction = datastore.transaction();
  */
 function Transaction(datastore) {

test/index.js

@@ -167,6 +167,10 @@ describe('Datastore', function() {
       var double = Datastore.double(aDouble);
       assert.strictEqual(double.value, aDouble);
     });
+
+    it('should also be on the prototype', function() {
+      assert.strictEqual(datastore.double, Datastore.double);
+    });
   });
 
   describe('geoPoint', function() {
@@ -175,6 +179,10 @@ describe('Datastore', function() {
       var geoPoint = Datastore.geoPoint(aGeoPoint);
       assert.strictEqual(geoPoint.value, aGeoPoint);
     });
+
+    it('should also be on the prototype', function() {
+      assert.strictEqual(datastore.geoPoint, Datastore.geoPoint);
+    });
   });
 
   describe('int', function() {
@@ -183,6 +191,10 @@ describe('Datastore', function() {
       var int = Datastore.int(anInt);
       assert.strictEqual(int.value, anInt);
     });
+
+    it('should also be on the prototype', function() {
+      assert.strictEqual(datastore.int, Datastore.int);
+    });
   });
 
   describe('MORE_RESULTS_AFTER_CURSOR', function() {
@@ -192,6 +204,13 @@ describe('Datastore', function() {
         'MORE_RESULTS_AFTER_CURSOR'
       );
     });
+
+    it('should also be on the prototype', function() {
+      assert.strictEqual(
+        datastore.MORE_RESULTS_AFTER_CURSOR,
+        Datastore.MORE_RESULTS_AFTER_CURSOR
+      );
+    });
   });
 
   describe('MORE_RESULTS_AFTER_LIMIT', function() {
@@ -201,12 +220,23 @@ describe('Datastore', function() {
         'MORE_RESULTS_AFTER_LIMIT'
       );
     });
+
+    it('should also be on the prototype', function() {
+      assert.strictEqual(
+        datastore.MORE_RESULTS_AFTER_LIMIT,
+        Datastore.MORE_RESULTS_AFTER_LIMIT
+      );
+    });
   });
 
   describe('NO_MORE_RESULTS', function() {
     it('should expose a NO_MORE_RESULTS helper', function() {
       assert.strictEqual(Datastore.NO_MORE_RESULTS, 'NO_MORE_RESULTS');
     });
+
+    it('should also be on the prototype', function() {
+      assert.strictEqual(datastore.NO_MORE_RESULTS, Datastore.NO_MORE_RESULTS);
+    });
   });
 
   describe('createQuery', function() {