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 Oct 19, 2015
1 parent cd80ee0 commit 9175aef
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion 2.1/js/docs-setup.js
Original file line number Diff line number Diff line change
Expand Up @@ -838,7 +838,7 @@ NG_DOCS={
"type": "function",
"moduleName": "person",
"shortDescription": "Person",
"keywords": "_delete_ _facts_ _gender_ _names_ _save_ add addfact addname ancestor ancestry api array arrays attributes birth birthdate birthplace burial change changehistory changemessage changes childandparents children christening christning client conslusions convenience count couple couples create created data death deathdate deathplace default delete deleted deletefact deletename deleteperson descendency discussions display docs doesn element endpoint entries exist existing fact facts false familysearch female final follow followredirect full function functions gender generations getancestry getbirth getbirthdate getbirthplace getburial getburialdate getburialplace getchanges getchildandparentsrelationships getchildren getchristening getchristeningdate getchristeningplace getcouplerelationships getdeath getdeathdate getdeathplace getdescendancy getdiscussionrefs getdisplay getdisplaybirthdate getdisplaybirthplace getdisplaydeathdate getdisplaydeathplace getdisplaygender getdisplaylifespan getdisplayname getfact getfacts getgender getgivenname getid getidentifiers getmatches getmemorypersonarefs getnames getnotes getparents getpersistentidentifier getperson getpersonchanges getpersondiscussionrefs getpersonmatches getpersonnotes getpersonportraiturl getpersonsourcerefs getpersonsourcesquery getpersonurl getpersonwithrelationships getpreferredname getsourcerefs getsources getspouses getsurname headers history http https identifier identifiers includes isliving isreadonly lifespan links male map max memories message methods multiple names needed note notes number object objects optional org params parents parentsandchildren pass passed pedigree persistent persists person persondetails pid place portrait preferred promise promises read read-only redirect relationship relationships remove removes request requests resolved resolves response responses responseturn restore retrieve return returned save sdk searchandmatch set setfacts setgender setnames sources spouse spouses string strings surname true type types update updated url values year"
"keywords": "_delete_ _facts_ _gender_ _names_ _save_ add addfact addname ancestor ancestry api array arrays attributes birth birthdate birthplace burial change changehistory changemessage changes childandparents children christening christning client conslusions convenience count couple couples create created data death deathdate deathplace default delete deleted deletefact deletename deleteperson descendency discussions display docs doesn element endpoint entries exist existing fact facts false familysearch female final follow followredirect full function functions gender generations getancestry getbirth getbirthdate getbirthplace getburial getburialdate getburialplace getchanges getchildandparentsrelationships getchildren getchristening getchristeningdate getchristeningplace getcouplerelationships getdeath getdeathdate getdeathplace getdescendancy getdiscussionrefs getdisplay getdisplaybirthdate getdisplaybirthplace getdisplaydeathdate getdisplaydeathplace getdisplaygender getdisplaylifespan getdisplayname getfact getfacts getgender getgivenname getid getidentifiers getmatches getmemorypersonarefs getnames getnotes getparents getpersistentidentifier getperson getpersonchanges getpersondiscussionrefs getpersonmatches getpersonnotes getpersonportraiturl getpersonsourcerefs getpersonsourcesquery getpersonurl getpersonwithrelationships getpreferredname getsourcerefs getsources getspouses getsurname headers history http https identifier identifiers includes isliving isreadonly lifespan links male map max memories message methods multiple names needed note notes number object objects optional org params parents parentsandchildren pass passed pedigree persistent persists person persondetails pid place portrait preferred promise promises read read-only redirect relationship relationships remove removes request requests resolved resolves response responses restore retrieve return returned save sdk searchandmatch set setfacts setgender setnames sources spouse spouses string strings surname true type types update updated url values year"
},
{
"section": "api",
Expand Down
6 changes: 3 additions & 3 deletions 2.1/partials/api/person.types.constructor.Person.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,16 +77,16 @@ <h4 id="usage_parameters">Parameters</h4><table class="variables-matrix table ta
<div class="getburialplace"><h5 id="methods_getburialplace_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="person-types-page person-types-constructor-person-getburialplace-page"><p>Birth place</p>
</div></td></tr></table></div>
</li>
<li><h3 id="methods_getchanges">getChanges(pid, params:)</h3>
<li><h3 id="methods_getchanges">getChanges(pid, params)</h3>
<div class="getchanges"><div class="person-types-page person-types-constructor-person-getchanges-page"><p>Get change history for a person
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">FamilySearch API Docs</a></p>
</div><h5 id="methods_getchanges_parameters">Parameters</h5><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>pid</td><td><a href="" class="label type-hint type-hint-string">String</a></td><td><div class="person-types-page person-types-constructor-person-getchanges-page"><p>id of the person or full URL of the person 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="person-types-page person-types-constructor-person-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><h5 id="methods_getchanges_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="person-types-page person-types-constructor-person-getchanges-page"><p>promise for the responseturn {Object} promise for the <a href="#/api/changeHistory.functions:getPersonChanges">getPersonChanges</a> response</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="person-types-page person-types-constructor-person-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><h5 id="methods_getchanges_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="person-types-page person-types-constructor-person-getchanges-page"><p>promise for the <a href="#/api/changeHistory.functions:getPersonChanges">getPersonChanges</a> response</p>
</div></td></tr></table></div>
</li>
<li><h3 id="methods_getchildren">getChildren()</h3>
Expand Down
4 changes: 2 additions & 2 deletions familysearch-javascript-sdk.js
Original file line number Diff line number Diff line change
Expand Up @@ -5863,8 +5863,8 @@ Person.prototype = utils.extend(Object.create(FS.BaseClass.prototype), {
*
*
* @param {String} pid id of the person or full URL of the person 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 responseturn {Object} promise for the {@link changeHistory.functions:getPersonChanges getPersonChanges} response
* @param {Object=} params `count` is the number of change entries to return, `from` to return changes following this id
* @return {Object} promise for the {@link changeHistory.functions:getPersonChanges getPersonChanges} response
*/
getChanges: function(params) {
var self = this;
Expand Down

0 comments on commit 9175aef

Please sign in to comment.