Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documented runQuery's callback parameters. #644

Merged
merged 1 commit into from
Jun 8, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/site/components/docs/docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
1 change: 1 addition & 0 deletions docs/site/components/docs/docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
13 changes: 13 additions & 0 deletions docs/site/css/main.css
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down
8 changes: 8 additions & 0 deletions lib/datastore/request.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
* //-
Expand Down