Skip to content

Commit

Permalink
Update docs and files to distribute
Browse files Browse the repository at this point in the history
  • Loading branch information
Travis committed Nov 9, 2015
1 parent 755855c commit 03cfcb5
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 6 deletions.
6 changes: 3 additions & 3 deletions 2.1/js/docs-setup.js
Original file line number Diff line number Diff line change
Expand Up @@ -158,11 +158,11 @@ NG_DOCS={
},
{
"section": "api",
"id": "changeHistory.functions:getPersonChanges",
"shortName": "getPersonChanges",
"id": "changeHistory.functions:getChanges",
"shortName": "getChanges",
"type": "function",
"moduleName": "changeHistory",
"shortDescription": "Get change history for a person",
"shortDescription": "Get change history for a person, couple, or child and parents.",
"keywords": "api array change changehistory changes child convenience count couple docs endpoint entries full function functions getchanges history https includes number org params parent parents person promise response return types url"
},
{
Expand Down
22 changes: 22 additions & 0 deletions 2.1/partials/api/changeHistory.functions.getChanges.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<h1><code ng:non-bindable="">getChanges</code>
<div><span class="hint">functions in module <code ng:non-bindable="">changeHistory</code>
</span>
</div>
</h1>
<div><h2 id="description">Description</h2>
<div class="description"><div class="changehistory-functions-page changehistory-functions-getchanges-page"><p>Get change history for a person, couple, or child and parents.
The response includes the following convenience function</p>
<ul>
<li><code>getChanges()</code> - get the array of <a href="#/api/changeHistory.types:constructor.Change">Changes</a> from the response</li>
</ul>
<p><a href="https://familysearch.org/developers/docs/api/tree/Person_Change_History_resource">Person Changes API Docs</a>
<a href="https://familysearch.org/developers/docs/api/tree/Child-and-Parents_Relationship_Change_History_resource">Child and Parents Changes API Docs</a>
<a href="https://familysearch.org/developers/docs/api/tree/Couple_Relationship_Change_History_resource">Couple Changes API Docs</a></p>
</div></div>
<h2 id="usage">Usage</h2>
<div class="usage"><pre class="prettyprint linenums">getChanges(url[, params:]);</pre>
<h4 id="usage_parameters">Parameters</h4><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>url</td><td><a href="" class="label type-hint type-hint-string">String</a></td><td><div class="changehistory-functions-page changehistory-functions-getchanges-page"><p>full URL of the person changes, child and parent changes, or couple changes endpoint</p>
</div></td></tr><tr><td>params: <div><em>(optional)</em></div></td><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="changehistory-functions-page changehistory-functions-getchanges-page"><p><code>count</code> is the number of change entries to return, <code>from</code> to return changes following this id</p>
</div></td></tr></tbody></table><h4 id="usage_returns">Returns</h4><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="changehistory-functions-page changehistory-functions-getchanges-page"><p>promise for the response</p>
</div></td></tr></table></div>
</div>
6 changes: 3 additions & 3 deletions familysearch-javascript-sdk.js
Original file line number Diff line number Diff line change
Expand Up @@ -8599,11 +8599,11 @@ FS.prototype._changeHistoryResponseMapper = function(response){

/**
* @ngdoc function
* @name changeHistory.functions:getPersonChanges
* @name changeHistory.functions:getChanges
*
* @description
* Get change history for a person
* Get change history for a person, couple, or child and parents.
* The response includes the following convenience function
*
* - `getChanges()` - get the array of {@link changeHistory.types:constructor.Change Changes} from the response
Expand All @@ -8613,7 +8613,7 @@ FS.prototype._changeHistoryResponseMapper = function(response){
* {@link https://familysearch.org/developers/docs/api/tree/Couple_Relationship_Change_History_resource Couple Changes API Docs}
*
*
* @param {String} url full URL of the person changes. child and parent changes, or couple changes endpoint
* @param {String} url full URL of the person changes, child and parent changes, or couple changes endpoint
* @param {Object=} params: `count` is the number of change entries to return, `from` to return changes following this id
* @return {Object} promise for the response
*/
Expand Down

0 comments on commit 03cfcb5

Please sign in to comment.