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 Apr 15, 2014
1 parent 2ccaeb0 commit d61cd1c
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 13 deletions.
6 changes: 3 additions & 3 deletions familysearch-javascript-sdk.js
Original file line number Diff line number Diff line change
Expand Up @@ -2321,7 +2321,7 @@ define('authorities',[

/**
* @ngdoc function
* @name authorities.functions:getPlace
* @name authorities.functions:getPlaceSearch
* @function
*
* @description
Expand All @@ -2337,7 +2337,7 @@ define('authorities',[
* @param {Object=} opts options to pass to the http function specified during init
* @return {Object} promise for the response
*/
exports.getPlace = function(place, opts) {
exports.getPlaceSearch = function(place, opts) {
var params = {
place: place,
view: 'simple',
Expand Down Expand Up @@ -10770,7 +10770,7 @@ define('FamilySearch',[
Date: authorities.Date,
Place: authorities.Place,
getDate: authorities.getDate,
getPlace: authorities.getPlace,
getPlaceSearch: authorities.getPlaceSearch,

// changeHistory
Change: changeHistory.Change,
Expand Down
4 changes: 2 additions & 2 deletions familysearch-javascript-sdk.min.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions js/docs-setup.js
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,8 @@ NG_DOCS={
},
{
"section": "api",
"id": "authorities.functions:getPlace",
"shortName": "getPlace",
"id": "authorities.functions:getPlaceSearch",
"shortName": "getPlaceSearch",
"type": "function",
"moduleName": "authorities",
"shortDescription": "Get the standardized place",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
<h1><code ng:non-bindable="">getPlace</code>
<h1><code ng:non-bindable="">getPlaceSearch</code>
<div><span class="hint">functions in module <code ng:non-bindable="">authorities</code>
</span>
</div>
</h1>
<div><h2 id="description">Description</h2>
<div class="description"><div class="authorities-functions-page authorities-functions-getplace-page"><p>Get the standardized place</p>
<div class="description"><div class="authorities-functions-page authorities-functions-getplacesearch-page"><p>Get the standardized place</p>
<ul>
<li><code>getPlaces()</code> - get the array of <a href="#/api/authorities.types:constructor.Place">Places</a> from the response</li>
</ul>
<p><a href="https://familysearch.org/developers/docs/guides/authorities/place-authority">FamilySearch API Docs</a></p>
<p><a href="http://jsfiddle.net/DallanQ/xrsAQ/">editable example</a></p>
</div></div>
<h2 id="usage">Usage</h2>
<div class="usage"><pre class="prettyprint linenums">getPlace(place[, opts]);</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>place</td><td><a href="" class="label type-hint type-hint-string">String</a></td><td><div class="authorities-functions-page authorities-functions-getplace-page"><p>text to standardize</p>
</div></td></tr><tr><td>opts <div><em>(optional)</em></div></td><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="authorities-functions-page authorities-functions-getplace-page"><p>options to pass to the http function specified during init</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="authorities-functions-page authorities-functions-getplace-page"><p>promise for the response</p>
<div class="usage"><pre class="prettyprint linenums">getPlaceSearch(place[, opts]);</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>place</td><td><a href="" class="label type-hint type-hint-string">String</a></td><td><div class="authorities-functions-page authorities-functions-getplacesearch-page"><p>text to standardize</p>
</div></td></tr><tr><td>opts <div><em>(optional)</em></div></td><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="authorities-functions-page authorities-functions-getplacesearch-page"><p>options to pass to the http function specified during init</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="authorities-functions-page authorities-functions-getplacesearch-page"><p>promise for the response</p>
</div></td></tr></table></div>
</div>

0 comments on commit d61cd1c

Please sign in to comment.