Skip to content

Commit

Permalink
Merge pull request #743 from Turfjs/update-line-segment
Browse files Browse the repository at this point in the history
line-segment: Remove redundant documentation.
  • Loading branch information
DenisCarriere authored May 14, 2017
2 parents b3f2758 + 9bb6bac commit 448c022
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion packages/turf-line-segment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Creates a [FeatureCollection](http://geojson.org/geojson-spec.html#feature-colle

**Parameters**

- `geojson` **([GeometryCollection](http://geojson.org/geojson-spec.html#geometrycollection) \| [Geometry](http://geojson.org/geojson-spec.html#geometry) \| [FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects) \| [Feature](http://geojson.org/geojson-spec.html#feature-objects)<([LineString](http://geojson.org/geojson-spec.html#linestring) \| [MultiLineString](http://geojson.org/geojson-spec.html#multilinestring) \| [MultiPolygon](http://geojson.org/geojson-spec.html#multipolygon) \| [Polygon](http://geojson.org/geojson-spec.html#polygon))>)** GeoJSON Polygon or LineString
- `geojson` **([Geometry](http://geojson.org/geojson-spec.html#geometry) \| [FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects) \| [Feature](http://geojson.org/geojson-spec.html#feature-objects)<([LineString](http://geojson.org/geojson-spec.html#linestring) \| [MultiLineString](http://geojson.org/geojson-spec.html#multilinestring) \| [MultiPolygon](http://geojson.org/geojson-spec.html#multipolygon) \| [Polygon](http://geojson.org/geojson-spec.html#polygon))>)** GeoJSON Polygon or LineString

**Examples**

Expand Down
2 changes: 1 addition & 1 deletion packages/turf-line-segment/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ var lineString = require('@turf/helpers').lineString;
* Creates a {@link FeatureCollection} of 2-vertex {@link LineString} segments from a {@link LineString|(Multi)LineString} or {@link Polygon|(Multi)Polygon}.
*
* @name lineSegment
* @param {GeometryCollection|Geometry|FeatureCollection|Feature<LineString|MultiLineString|MultiPolygon|Polygon>} geojson GeoJSON Polygon or LineString
* @param {Geometry|FeatureCollection|Feature<LineString|MultiLineString|MultiPolygon|Polygon>} geojson GeoJSON Polygon or LineString
* @returns {FeatureCollection<LineString>} 2-vertex line segments
* @example
* var polygon = {
Expand Down

0 comments on commit 448c022

Please sign in to comment.