Merge pull request #1888 from chris-catignani/fix_greater_circle_read…

…me_example greaterCircle fix for readme example
Turfjs · May 2, 2020 · bf0a3c9 · bf0a3c9
2 parents b830207 + 114daf3
commit bf0a3c9
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/packages/turf-great-circle/README.md b/packages/turf-great-circle/README.md
@@ -6,7 +6,7 @@
 
 Calculate great circles routes as [LineString][1]
 
-**Parameters**
+### Parameters
 
 -   `start` **[Coord][2]** source point feature
 -   `end` **[Coord][2]** destination point feature
@@ -16,13 +16,13 @@ Calculate great circles routes as [LineString][1]
     -   `options.offset` **[number][4]** offset controls the likelyhood that lines will
         be split which cross the dateline. The higher the number the more likely. (optional, default `10`)
 
-**Examples**
+### Examples
 
 ```javascript
 var start = turf.point([-122, 48]);
 var end = turf.point([-77, 39]);
 
-var greatCircle = turf.greatCircle(start, end, {'name': 'Seattle to DC'});
+var greatCircle = turf.greatCircle(start, end, {properties: {name: 'Seattle to DC'}});
 
 //addToMap
 var addToMap = [start, end, greatCircle]

diff --git a/packages/turf-great-circle/index.js b/packages/turf-great-circle/index.js
@@ -17,7 +17,7 @@ import { GreatCircle } from './lib/arc';
  * var start = turf.point([-122, 48]);
  * var end = turf.point([-77, 39]);
  *
- * var greatCircle = turf.greatCircle(start, end, {'name': 'Seattle to DC'});
+ * var greatCircle = turf.greatCircle(start, end, {properties: {name: 'Seattle to DC'}});
  *
  * //addToMap
  * var addToMap = [start, end, greatCircle]