Documented runQuery's callback parameters.

googleapis · Jun 8, 2015 · 145660b · 145660b
1 parent 67f795b
commit 145660b
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 1 deletion.
diff --git a/docs/site/components/docs/docs.html b/docs/site/components/docs/docs.html
@@ -104,7 +104,13 @@ <h4 ng-show="method.params">Parameters</h4>
           <tr
             ng-repeat="param in method.params"
             ng-class="{ 'param-optional': param.optional }">
-            <th scope="row">{{param.name}}</th>
+            <th scope="row" class="param">
+              <span ng-if="param.subparam" class="param-parent">
+                <div>{{param.name.split('.').slice(0, -1).join('.')}}</div>
+                &#8627;
+              </span>
+              {{param.name.split('.').slice(-1)[0]}}
+            </th>
             <td class="param-types" ng-bind-html="param.types"></td>
             <td class="param-description" ng-bind-html="param.description"></td>
           </tr>

diff --git 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
@@ -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
@@ -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
  * //-