Readme note (Turfjs#455)

packages/turf-along/README.md

@@ -41,6 +41,10 @@ var result = {
 
 Returns **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Point](http://geojson.org/geojson-spec.html#point)>** Point `distance` `units` along the line
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-area/README.md

@@ -2,7 +2,7 @@
 
 # area
 
-Takes a one or more features and returns their area
+Takes one or more features and returns their area
 in square meters.
 
 **Parameters**
@@ -52,6 +52,10 @@ var area = turf.area(polygons);
 
 Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** area in square meters
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-bbox-polygon/README.md

@@ -20,6 +20,10 @@ var poly = turf.bboxPolygon(bbox);
 
 Returns **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Polygon](http://geojson.org/geojson-spec.html#polygon)>** a Polygon representation of the bounding box
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-bbox/README.md

@@ -62,6 +62,10 @@ var result = {
 Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>** the bounding box of `input` given
 as an array in WSEN order (west, south, east, north)
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-bearing/README.md

@@ -47,6 +47,10 @@ var bearing = turf.bearing(point1, point2);
 
 Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** bearing in decimal degrees
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-bezier/README.md

@@ -48,6 +48,10 @@ var result = {
 
 Returns **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[LineString](http://geojson.org/geojson-spec.html#linestring)>** curved line
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-buffer/README.md

@@ -31,6 +31,10 @@ var result = turf.featurecollection([buffered, pt]);
 
 Returns **([FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects)<[Polygon](http://geojson.org/geojson-spec.html#polygon)> | [FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects)<[MultiPolygon](http://geojson.org/geojson-spec.html#multipolygon)> | [Polygon](http://geojson.org/geojson-spec.html#polygon) \| [MultiPolygon](http://geojson.org/geojson-spec.html#multipolygon))** buffered features
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-center-of-mass/README.md

@@ -113,6 +113,10 @@ var centerOfMass = turf.center-of-mass(feature);
 
 Returns **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Point](http://geojson.org/geojson-spec.html#point)>** the center of mass
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-center/README.md

@@ -118,6 +118,10 @@ var result = {
 Returns **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Point](http://geojson.org/geojson-spec.html#point)>** a Point feature at the
 absolute center point of all input features
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-centroid/README.md

@@ -41,6 +41,10 @@ var result = {
 
 Returns **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Point](http://geojson.org/geojson-spec.html#point)>** the centroid of the input features
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-circle/README.md

@@ -40,6 +40,10 @@ var result = {
 
 Returns **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Polygon](http://geojson.org/geojson-spec.html#polygon)>** circle polygon
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-collect/README.md

@@ -2,11 +2,11 @@
 
 # collect
 
-Joins attributes FeatureCollection of polygons with a FeatureCollection of
-points. Given an `inProperty` on points and an `outProperty` for polygons,
-this finds every point that lies within each polygon, collects the `inProperty`
-values from those points, and adds them as an array to `outProperty` on the
-polygon.
+Merges a specified property from a FeatureCollection of points into a
+FeatureCollection of polygons. Given an `inProperty` on points and an `outProperty`
+for polygons, this finds every point that lies within each polygon, collects the
+`inProperty` values from those points, and adds them as an array to `outProperty`
+on the polygon.
 
 **Parameters**
 
@@ -34,6 +34,10 @@ aggregated.features[0].properties.values // => [200, 600]);
 
 Returns **[FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects)<[Polygon](http://geojson.org/geojson-spec.html#polygon)>** polygons with properties listed based on `outField`
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-combine/README.md

@@ -42,6 +42,10 @@ var combined = turf.combine(fc);
 
 Returns **[FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects)<([MultiPoint](http://geojson.org/geojson-spec.html#multipoint) \| [MultiLineString](http://geojson.org/geojson-spec.html#multilinestring) \| [MultiPolygon](http://geojson.org/geojson-spec.html#multipolygon))>** a FeatureCollection of corresponding type to input
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-concave/README.md

@@ -81,6 +81,10 @@ var result = {
 
 Returns **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Polygon](http://geojson.org/geojson-spec.html#polygon)>** a concave hull
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-convex/README.md

@@ -79,6 +79,10 @@ var result = {
 
 Returns **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Polygon](http://geojson.org/geojson-spec.html#polygon)>** a convex hull
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-destination/README.md

@@ -41,6 +41,10 @@ var result = {
 
 Returns **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Point](http://geojson.org/geojson-spec.html#point)>** destination point
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-difference/README.md

@@ -61,6 +61,10 @@ var polygons = {
 
 Returns **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Polygon](http://geojson.org/geojson-spec.html#polygon)>** a Polygon feature showing the area of `poly1` excluding the area of `poly2`
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-distance/README.md

@@ -48,6 +48,10 @@ var distance = turf.distance(from, to, units);
 
 Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** distance between the two points
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-envelope/README.md

@@ -58,6 +58,10 @@ var result = {
 
 Returns **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Polygon](http://geojson.org/geojson-spec.html#polygon)>** a rectangular Polygon feature that encompasses all vertices
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-explode/README.md

@@ -40,6 +40,10 @@ var points = turf.explode(poly);
 
 Returns **[FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects)<point>** points representing the exploded input features
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-flip/README.md

@@ -30,6 +30,10 @@ var saudiArabia = turf.flip(serbia);
 
 Returns **([Feature](http://geojson.org/geojson-spec.html#feature-objects) \| [FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects))** a feature or set of features of the same type as `input` with flipped coordinates
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-helpers/README.md

@@ -229,6 +229,10 @@ var collection = turf.geometrycollection([[0,0],[10,10]]);
 
 Returns **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[GeometryCollection](http://geojson.org/geojson-spec.html#geometrycollection)>** a geometrycollection feature
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-hex-grid/README.md

@@ -27,6 +27,10 @@ var hexgrid = turf.hexGrid(bbox, cellWidth, units);
 
 Returns **[FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects)<[Polygon](http://geojson.org/geojson-spec.html#polygon)>** a hexagonal grid
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-idw/README.md

@@ -17,6 +17,10 @@ from a set of spatially scattered points.
 
 Returns **[FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects)<[Polygon](http://geojson.org/geojson-spec.html#polygon)>** grid A grid of polygons with a property field "IDW"
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-inside/README.md

@@ -64,6 +64,10 @@ var isInside2 = turf.inside(pt2, poly);
 
 Returns **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** `true` if the Point is inside the Polygon; `false` if the Point is not inside the Polygon
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-intersect/README.md

@@ -62,6 +62,10 @@ var intersection = turf.intersect(poly1, poly2);
 
 Returns **([Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Polygon](http://geojson.org/geojson-spec.html#polygon)> | [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined) \| [Feature](http://geojson.org/geojson-spec.html#feature-objects)<[MultiLineString](http://geojson.org/geojson-spec.html#multilinestring)>)** if `poly1` and `poly2` overlap, returns a Polygon feature representing the area they overlap; if `poly1` and `poly2` do not overlap, returns `undefined`; if `poly1` and `poly2` share a border, a MultiLineString of the locations where their borders are shared
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-invariant/README.md

@@ -52,6 +52,10 @@ Internally this uses [geojsonType](#geojsontype) to judge geometry types.
 
 -   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** if value is not the expected type.
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-isolines/README.md

@@ -30,6 +30,10 @@ var isolined = turf.isolines(points, 'z', 15, breaks);
 
 Returns **[FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects)<[LineString](http://geojson.org/geojson-spec.html#linestring)>** isolines
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-kinks/README.md

@@ -39,6 +39,10 @@ var result = {
 
 Returns **[FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects)<[Point](http://geojson.org/geojson-spec.html#point)>** self-intersections
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-line-distance/README.md

@@ -37,6 +37,10 @@ var length = turf.lineDistance(line, 'miles');
 
 Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** length of the input line
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-line-slice-along/README.md

@@ -50,6 +50,10 @@ var sliced = turf.lineSliceAlong(start, stop, line, units);
 
 Returns **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[LineString](http://geojson.org/geojson-spec.html#linestring)>** sliced line
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-line-slice/README.md

@@ -58,6 +58,10 @@ var sliced = turf.lineSlice(start, stop, line);
 
 Returns **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[LineString](http://geojson.org/geojson-spec.html#linestring)>** sliced line
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-meta/README.md

@@ -102,6 +102,10 @@ arrays.
 
 Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>>** coordinate position array
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source

packages/turf-midpoint/README.md

@@ -44,6 +44,10 @@ var result = {
 
 Returns **[Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Point](http://geojson.org/geojson-spec.html#point)>** a point midway between `pt1` and `pt2`
 
+<!-- This file is automatically generated. Please don't edit it directly:
+if you find an error, edit the source file (likely index.js), and re-run
+./scripts/generate-readmes in the turf project. -->
+
 ---
 
 This module is part of the [Turfjs project](http://turfjs.org/), an open source