From 145660b9a59a9b6aa044db3a161f8f9f7515ae1b Mon Sep 17 00:00:00 2001 From: JJ Geewax Date: Mon, 8 Jun 2015 12:19:39 -0400 Subject: [PATCH] Documented runQuery's callback parameters. --- docs/site/components/docs/docs.html | 8 +++++++- docs/site/components/docs/docs.js | 1 + docs/site/css/main.css | 13 +++++++++++++ lib/datastore/request.js | 8 ++++++++ 4 files changed, 29 insertions(+), 1 deletion(-) diff --git a/docs/site/components/docs/docs.html b/docs/site/components/docs/docs.html index 079531cf1cc..db52f502ba4 100644 --- a/docs/site/components/docs/docs.html +++ b/docs/site/components/docs/docs.html @@ -104,7 +104,13 @@

Parameters

- {{param.name}} + + +
{{param.name.split('.').slice(0, -1).join('.')}}
+ ↳ +
+ {{param.name.split('.').slice(-1)[0]}} + diff --git a/docs/site/components/docs/docs.js b/docs/site/components/docs/docs.js index 24f9ece02e4..5b373fcb6eb 100644 --- a/docs/site/components/docs/docs.js +++ b/docs/site/components/docs/docs.js @@ -160,6 +160,7 @@ angular tag.types = $sce.trustAsHtml(tag.types.reduceRight( reduceModules, []).join(', ')); tag.optional = tag.types.toString().indexOf('=') > -1; + tag.subparam = tag.name.indexOf('.') > -1; return tag; }), returns: obj.tags.filter(function(tag) { diff --git a/docs/site/css/main.css b/docs/site/css/main.css index bd9edf37d43..aed0a7d13b5 100755 --- a/docs/site/css/main.css +++ b/docs/site/css/main.css @@ -730,6 +730,19 @@ ul { border-bottom: 1px solid rgba(0,0,0,0.05); } +.param { + white-space: nowrap; +} + +.param-parent { + font-weight: normal; +} + +.param-parent > div { + font-size: 80%; + line-height: 50%; +} + .param-optional .param-types { font-style: italic; } diff --git a/lib/datastore/request.js b/lib/datastore/request.js index 656aeaaa2ba..b01d74b414a 100644 --- a/lib/datastore/request.js +++ b/lib/datastore/request.js @@ -463,6 +463,14 @@ DatastoreRequest.prototype.delete = function(keys, callback) { * @param {module:datastore/query} q - Query object. * @param {function=} callback - The callback function. If omitted, a readable * stream instance is returned. + * @param {?Error} callback.err - An error returned while making this request + * (may be null). + * @param {Array} callback.entities - The list of entities returned by this + * query. Note that this is a single page of entities, not necessarily + * all of the entities. + * @param {String} callback.endCursor - The end cursor of this current query, + * which can be used as the starting cursor of the next query. + * @param {Object} callback.apiResponse - The full API response. * * @example * //-