From 114daf397699e7db3b8ba0a8a753b25400029ee1 Mon Sep 17 00:00:00 2001 From: chris-catignani Date: Sat, 25 Apr 2020 16:13:56 -0400 Subject: [PATCH] Fix for greater circle readme example --- packages/turf-great-circle/README.md | 6 +++--- packages/turf-great-circle/index.js | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/turf-great-circle/README.md b/packages/turf-great-circle/README.md index befb79d8bd..4da90b6b12 100644 --- 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 index a181381202..2fb51ce2ac 100644 --- 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]