Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

greaterCircle fix for readme example #1888

Merged
merged 1 commit into from
May 2, 2020
Merged

greaterCircle fix for readme example #1888

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/turf-great-circle/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Copy link
Contributor Author

@chris-catignani chris-catignani Apr 25, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this was updated when i ran npm run docs, and contains no manual changes

Calculate great circles routes as [LineString][1]

**Parameters**
### Parameters

- `start` **[Coord][2]** source point feature
- `end` **[Coord][2]** destination point feature
Expand All @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion packages/turf-great-circle/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down