Skip to content

Commit

Permalink
Merge pull request #576 from jgeewax/query-reference-doc-fix
Browse files Browse the repository at this point in the history
Make query reference links more explanatory.
  • Loading branch information
ryanseys committed May 11, 2015
2 parents 412598c + 6830fc2 commit 60de980
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions lib/datastore/query.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ var util = require('../common/util.js');
* {@linkcode module:datastore/dataset#createQuery} and run via
* {@linkcode module:datastore/dataset#runQuery}.**
*
* *[Reference](http://goo.gl/Cag0r6).*
* *[More information on queries](http://goo.gl/Cag0r6).*
*
* @constructor
* @alias module:datastore/query
Expand Down Expand Up @@ -82,7 +82,7 @@ function Query(namespace, kinds) {
*
* *To filter by ancestors, see {@linkcode module:datastore/query#hasAncestor}.*
*
* *[Reference](http://goo.gl/ENCx7e).*
* *[More information on filtering by properties](http://goo.gl/ENCx7e).*
*
* @param {string} filter - Property + Operator (=, <, >, <=, >=).
* @param {*} value - Value to compare property to.
Expand Down Expand Up @@ -116,7 +116,7 @@ Query.prototype.filter = function(filter, value) {
/**
* Filter a query by ancestors.
*
* *[Reference](http://goo.gl/1qfpkZ).*
* *[More information on filtering by ancestors](http://goo.gl/1qfpkZ).*
*
* @param {Key} key - Key object to filter by.
* @return {module:datastore/query}
Expand All @@ -134,7 +134,7 @@ Query.prototype.hasAncestor = function(key) {
* Sort the results by a property name in ascending or descending order. By
* default, an ascending sort order will be used.
*
* *[Reference](http://goo.gl/mfegFR).*
* *[More information on sort orders](http://goo.gl/mfegFR).*
*
* @param {string} property - Optional operator (+, -) and property to order by.
* @return {module:datastore/query}
Expand Down Expand Up @@ -176,7 +176,9 @@ Query.prototype.groupBy = function(fieldNames) {
/**
* Retrieve only select properties from the matched entities.
*
* *[Reference](http://goo.gl/EfsrJl).*
* Queries that select a subset of properties are called Projection Queries.
*
* *[More information on projection queries](http://goo.gl/EfsrJl).*
*
* @param {array} fieldNames - Properties to return from the matched entities.
* @return {module:datastore/query}
Expand All @@ -194,7 +196,7 @@ Query.prototype.select = function(fieldNames) {
/**
* Set a starting cursor to a query.
*
* *[Reference](http://goo.gl/WuTGRI).*
* *[More information on query cursors](http://goo.gl/WuTGRI).*
*
* @param {string} cursorToken - The starting cursor token.
* @return {module:datastore/query}
Expand All @@ -214,7 +216,7 @@ Query.prototype.start = function(start) {
/**
* Set an ending cursor to a query.
*
* *[Reference](http://goo.gl/WuTGRI).*
* *[More information on query cursors](http://goo.gl/WuTGRI).*
*
* @param {string} cursorToken - The ending cursor token.
* @return {module:datastore/query}
Expand All @@ -234,7 +236,7 @@ Query.prototype.end = function(end) {
/**
* Set a limit on a query.
*
* *[Reference](http://goo.gl/f0VZ0n).*
* *[More information on query limits](http://goo.gl/f0VZ0n).*
*
* @param {number} n - The number of results to limit the query to.
* @return {module:datastore/query}
Expand All @@ -252,7 +254,7 @@ Query.prototype.limit = function(n) {
/**
* Set an offset on a query.
*
* *[Reference](http://goo.gl/f0VZ0n).*
* *[More information on query offsets](http://goo.gl/f0VZ0n).*
*
* @param {number} n - The offset to start from after the start cursor.
* @return {module:datastore/query}
Expand Down

0 comments on commit 60de980

Please sign in to comment.