search

Turfjs / turf

A modular geospatial engine written in JavaScript and TypeScript
https://turfjs.org/
MIT License
9.3k stars 941 forks source link

Update API Docs #992

Closed bwyss closed 7 years ago

bwyss commented 7 years ago

A small thing, the API docs under Meta / getGeom reads:

var geom = turf.getGeom(point)

Should be:

var geom = turf.invariant.getGeom(point)

DenisCarriere commented 7 years ago

When using @turf/turf it exposes all the sub methods.

is valid

var geom = turf.getGeom(point)

won't work in v5.0 (maybe it should.. 🤔 )

var geom = turf.invariant.getGeom(point)

Ref: https://github.com/Turfjs/turf/blob/master/packages/turf/index.js#L101

bwyss commented 7 years ago

thx! I absolutely love the library by the way!!!

DenisCarriere commented 7 years ago

👍 @bwyss Thanks, don't hesitate to submit more issues if something isn't conforming to the GeoJSON spec.