Merge pull request #2802 from protokoul/docs/update-package-json-for-…

…turf-packages Updated package.json description for all turf packages to be more informative
Turfjs · Jan 8, 2025 · 991d3ac · 991d3ac
2 parents 2131d78 + df836d1
commit 991d3ac
Show file tree

Hide file tree

Showing 113 changed files with 113 additions and 113 deletions.
diff --git a/packages/turf-along/package.json b/packages/turf-along/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/along",
   "version": "7.2.0",
-  "description": "turf along module",
+  "description": "Calculates a point along a line at a specific distance",
   "author": "Turf Authors",
   "license": "MIT",
   "bugs": {

diff --git a/packages/turf-angle/package.json b/packages/turf-angle/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/angle",
   "version": "7.2.0",
-  "description": "turf angle module",
+  "description": "Finds the angle formed by two adjacent segments.",
   "author": "Turf Authors",
   "contributors": [
     "Denis <@DenisCarriere>"

diff --git a/packages/turf-area/package.json b/packages/turf-area/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/area",
   "version": "7.2.0",
-  "description": "turf area module",
+  "description": "Calculates the geodesic area in square meters of one or more polygons.",
   "author": "Turf Authors",
   "license": "MIT",
   "bugs": {

diff --git a/packages/turf-bbox-clip/package.json b/packages/turf-bbox-clip/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/bbox-clip",
   "version": "7.2.0",
-  "description": "turf bbox-clip module",
+  "description": "Takes a Feature and a bbox and clips the feature to the bbox using lineclip.",
   "author": "Turf Authors",
   "contributors": [
     "Tim Channell <@tcql>",

diff --git a/packages/turf-bbox-polygon/package.json b/packages/turf-bbox-polygon/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/bbox-polygon",
   "version": "7.2.0",
-  "description": "turf bbox-polygon module",
+  "description": "Converts a bounding box to a GeoJSON polygon.",
   "author": "Turf Authors",
   "license": "MIT",
   "bugs": {

diff --git a/packages/turf-bbox/package.json b/packages/turf-bbox/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/bbox",
   "version": "7.2.0",
-  "description": "turf bbox module",
+  "description": "Generates a bounding box around a GeoJSON feature.",
   "author": "Turf Authors",
   "license": "MIT",
   "bugs": {

diff --git a/packages/turf-bearing/package.json b/packages/turf-bearing/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/bearing",
   "version": "7.2.0",
-  "description": "turf bearing module",
+  "description": "Takes two points and finds the geographic bearing between them.",
   "author": "Turf Authors",
   "license": "MIT",
   "bugs": {

diff --git a/packages/turf-bezier-spline/package.json b/packages/turf-bezier-spline/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/bezier-spline",
   "version": "7.2.0",
-  "description": "turf bezier-spline module",
+  "description": "Smooths a line into a curve using Bézier splines, great for visualizing routes.",
   "author": "Turf Authors",
   "license": "MIT",
   "bugs": {

diff --git a/packages/turf-boolean-clockwise/package.json b/packages/turf-boolean-clockwise/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/boolean-clockwise",
   "version": "7.2.0",
-  "description": "turf boolean-clockwise module",
+  "description": "Takes a ring and return true or false whether or not the ring is clockwise or counter-clockwise.",
   "author": "Turf Authors",
   "contributors": [
     "Morgan Herlocker <@morganherlocker>",

diff --git a/packages/turf-boolean-concave/package.json b/packages/turf-boolean-concave/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/boolean-concave",
   "version": "7.2.0",
-  "description": "turf boolean-concave module",
+  "description": "Takes a polygon and return true or false as to whether it is concave or not.",
   "author": "Turf Authors",
   "contributors": [
     "Rowan Winsemius <@rowanwins>"

diff --git a/packages/turf-boolean-contains/package.json b/packages/turf-boolean-contains/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/boolean-contains",
   "version": "7.2.0",
-  "description": "turf boolean-contains module",
+  "description": "Determines whether the second geometry is completely within the first geometry.",
   "author": "Turf Authors",
   "contributors": [
     "Rowan Winsemius <@rowanwins>",

diff --git a/packages/turf-boolean-crosses/package.json b/packages/turf-boolean-crosses/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/boolean-crosses",
   "version": "7.2.0",
-  "description": "turf boolean-crosses module",
+  "description": "Checks if two geometries cross each other.",
   "author": "Turf Authors",
   "contributors": [
     "Rowan Winsemius <@rowanwins>",

diff --git a/packages/turf-boolean-disjoint/package.json b/packages/turf-boolean-disjoint/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/boolean-disjoint",
   "version": "7.2.0",
-  "description": "turf boolean-disjoint module",
+  "description": "Checks if two geometries have no overlapping areas.",
   "author": "Turf Authors",
   "contributors": [
     "Rowan Winsemius <@rowanwins>",

diff --git a/packages/turf-boolean-equal/package.json b/packages/turf-boolean-equal/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/boolean-equal",
   "version": "7.2.0",
-  "description": "turf boolean-equal module",
+  "description": "Determine whether two geometries of the same type have identical X,Y coordinate values",
   "author": "Turf Authors",
   "contributors": [
     "Tom MacWright <@tmcw>",

diff --git a/packages/turf-boolean-intersects/package.json b/packages/turf-boolean-intersects/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/boolean-intersects",
   "version": "7.2.0",
-  "description": "turf boolean-intersects module",
+  "description": "Checks if two geometries overlap in any way.",
   "author": "Turf Authors",
   "contributors": [
     "Rowan Winsemius <@rowanwins>",

diff --git a/packages/turf-boolean-overlap/package.json b/packages/turf-boolean-overlap/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/boolean-overlap",
   "version": "7.2.0",
-  "description": "turf boolean-overlap module",
+  "description": "Checks if two geometries have an area of overlap without one being completely contained inside the other.",
   "author": "Turf Authors",
   "contributors": [
     "Tim Channell <@tcql>",

diff --git a/packages/turf-boolean-parallel/package.json b/packages/turf-boolean-parallel/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/boolean-parallel",
   "version": "7.2.0",
-  "description": "turf boolean-parallel module",
+  "description": "Determine whether each segment of a line is parallel to the correspondent segment of another line.",
   "author": "Turf Authors",
   "contributors": [
     "Stefano Borghi <@stebogit>"

diff --git a/packages/turf-boolean-point-in-polygon/package.json b/packages/turf-boolean-point-in-polygon/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/boolean-point-in-polygon",
   "version": "7.2.0",
-  "description": "turf boolean-point-in-polygon module",
+  "description": "Checks if a point is inside an area, like a city boundary.",
   "author": "Turf Authors",
   "license": "MIT",
   "bugs": {

diff --git a/packages/turf-boolean-point-on-line/package.json b/packages/turf-boolean-point-on-line/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/boolean-point-on-line",
   "version": "7.2.0",
-  "description": "turf boolean-point-on-line module",
+  "description": "Checks if a point lies directly on a line, like a path or road.",
   "author": "Turf Authors",
   "contributors": [
     "Rowan Winsemius <@rowanwins>"

diff --git a/packages/turf-boolean-touches/package.json b/packages/turf-boolean-touches/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/boolean-touches",
   "version": "7.2.0",
-  "description": "turf boolean-touches module",
+  "description": "Determine whether none of the points common to both geometries intersect the interiors of both geometries.",
   "author": "Turf Authors",
   "contributors": [
     "Rowan Winsemius <@rowanwins>"

diff --git a/packages/turf-boolean-valid/package.json b/packages/turf-boolean-valid/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/boolean-valid",
   "version": "7.2.0",
-  "description": "turf boolean-valid module",
+  "description": "Checks if the geometry is a valid according to the OGC Simple Feature Specification.",
   "author": "Turf Authors",
   "contributors": [
     "Rowan Winsemius <@rowanwins>",

diff --git a/packages/turf-boolean-within/package.json b/packages/turf-boolean-within/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/boolean-within",
   "version": "7.2.0",
-  "description": "turf boolean-within module",
+  "description": "Determines whether the first geometry is completely within the second geometry.",
   "author": "Turf Authors",
   "contributors": [
     "Rowan Winsemius <@rowanwins>"

diff --git a/packages/turf-buffer/package.json b/packages/turf-buffer/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/buffer",
   "version": "7.2.0",
-  "description": "turf buffer module",
+  "description": "Creates a buffer around a GeoJSON feature.",
   "author": "Turf Authors",
   "contributors": [
     "Tom MacWright <@tmcw>",

diff --git a/packages/turf-center-mean/package.json b/packages/turf-center-mean/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/center-mean",
   "version": "7.2.0",
-  "description": "turf center-mean module",
+  "description": "Takes a Feature or FeatureCollection and returns the mean center.",
   "author": "Turf Authors",
   "contributors": [
     "Moacir P. de Sá Pereira <@muziejus>"

diff --git a/packages/turf-center-median/package.json b/packages/turf-center-median/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/center-median",
   "version": "7.2.0",
-  "description": "turf center-median module",
+  "description": "Takes a FeatureCollection of points and calculates the median center.",
   "author": "Turf Authors",
   "contributors": [
     "Moacir P. de Sá Pereira <@muziejus>"

diff --git a/packages/turf-center-of-mass/package.json b/packages/turf-center-of-mass/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/center-of-mass",
   "version": "7.2.0",
-  "description": "turf center-of-mass module",
+  "description": "Finds the “balance point” of irregular shapes, like a country outline.",
   "author": "Turf Authors",
   "license": "MIT",
   "bugs": {

diff --git a/packages/turf-center/package.json b/packages/turf-center/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/center",
   "version": "7.2.0",
-  "description": "turf center module",
+  "description": "Finds the central point of a GeoJSON feature, like a city or a park. Ideal for placing labels or markers.",
   "author": "Turf Authors",
   "license": "MIT",
   "bugs": {

diff --git a/packages/turf-centroid/package.json b/packages/turf-centroid/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/centroid",
   "version": "7.2.0",
-  "description": "turf centroid module",
+  "description": "Determines the geometric center of a polygon or shape.",
   "author": "Turf Authors",
   "license": "MIT",
   "bugs": {

diff --git a/packages/turf-circle/package.json b/packages/turf-circle/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/circle",
   "version": "7.2.0",
-  "description": "turf circle module",
+  "description": "Takes a point and calculates the circle polygon given a radius.",
   "author": "Turf Authors",
   "license": "MIT",
   "bugs": {

diff --git a/packages/turf-clean-coords/package.json b/packages/turf-clean-coords/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/clean-coords",
   "version": "7.2.0",
-  "description": "turf clean-coords module",
+  "description": "Removes redundant coordinates from a GeoJSON Geometry.",
   "author": "Turf Authors",
   "contributors": [
     "Stefano Borghi <@stebogit>"

diff --git a/packages/turf-clone/package.json b/packages/turf-clone/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/clone",
   "version": "7.2.0",
-  "description": "turf clone module",
+  "description": "Returns a cloned copy of the passed GeoJSON Object, including possible 'Foreign Members'.",
   "author": "Turf Authors",
   "contributors": [
     "Denis Carriere <@DenisCarriere>"

diff --git a/packages/turf-clusters-dbscan/package.json b/packages/turf-clusters-dbscan/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/clusters-dbscan",
   "version": "7.2.0",
-  "description": "turf clusters-dbscan module",
+  "description": "Takes a set of points and partition them into clusters according to DBSCAN's data clustering algorithm.",
   "author": "Turf Authors",
   "contributors": [
     "Lukasz <@uhho>",

diff --git a/packages/turf-clusters-kmeans/package.json b/packages/turf-clusters-kmeans/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/clusters-kmeans",
   "version": "7.2.0",
-  "description": "turf clusters-kmeans module",
+  "description": "Takes a set of points and partition them into clusters using the k-means algorithm.",
   "author": "Turf Authors",
   "contributors": [
     "David Gómez Matarrodona <@solzimer>",

diff --git a/packages/turf-clusters/package.json b/packages/turf-clusters/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/clusters",
   "version": "7.2.0",
-  "description": "turf clusters module",
+  "description": "Group points into clusters based on their spatial proximity or properties.",
   "author": "Turf Authors",
   "contributors": [
     "Denis Carriere <@DenisCarriere>"

diff --git a/packages/turf-collect/package.json b/packages/turf-collect/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/collect",
   "version": "7.2.0",
-  "description": "turf collect module",
+  "description": "Merges a specified property from a FeatureCollection of points into a FeatureCollection of polygons.",
   "author": "Turf Authors",
   "contributors": [
     "Rowan Winsemius <@rowanwins>"

diff --git a/packages/turf-combine/package.json b/packages/turf-combine/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/combine",
   "version": "7.2.0",
-  "description": "turf combine module",
+  "description": "Combines a FeatureCollection of Point, LineString, or Polygon features into MultiPoint, MultiLineString, or MultiPolygon features.",
   "author": "Turf Authors",
   "license": "MIT",
   "bugs": {

diff --git a/packages/turf-concave/package.json b/packages/turf-concave/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/concave",
   "version": "7.2.0",
-  "description": "turf concave module",
+  "description": "Creates a concave hull around points.",
   "author": "Turf Authors",
   "contributors": [
     "Tom MacWright <@tmcw>",

diff --git a/packages/turf-convex/package.json b/packages/turf-convex/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/convex",
   "version": "7.2.0",
-  "description": "turf convex module",
+  "description": "Creates a convex hull around points",
   "author": "Turf Authors",
   "license": "MIT",
   "bugs": {

diff --git a/packages/turf-difference/package.json b/packages/turf-difference/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/difference",
   "version": "7.2.0",
-  "description": "turf difference module",
+  "description": "Finds the difference between multiple polygons by clipping the subsequent polygon from the first.",
   "author": "Turf Authors",
   "license": "MIT",
   "bugs": {

diff --git a/packages/turf-directional-mean/package.json b/packages/turf-directional-mean/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/directional-mean",
   "version": "7.2.0",
-  "description": "turf directional-mean module",
+  "description": "Calculates the average angle of a set of lines, measuring the trend of it.",
   "author": "Turf Authors",
   "contributors": [
     "Haoming Zhuang <@zhuang-hao-ming>"

diff --git a/packages/turf-dissolve/package.json b/packages/turf-dissolve/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/dissolve",
   "version": "7.2.0",
-  "description": "turf dissolve module",
+  "description": "Dissolves a FeatureCollection of Polygon features.",
   "author": "Turf Authors",
   "license": "MIT",
   "bugs": {

diff --git a/packages/turf-distance-weight/package.json b/packages/turf-distance-weight/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/distance-weight",
   "version": "7.2.0",
-  "description": "turf distance-weight module",
+  "description": "Calculate the influence or weight of points over an area based on their distances.",
   "author": "Turf Authors",
   "contributors": [
     "Haoming Zhuang <@zhuang-hao-ming>"

diff --git a/packages/turf-distance/package.json b/packages/turf-distance/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/distance",
   "version": "7.2.0",
-  "description": "turf distance module",
+  "description": "Measures the straight-line distance between two points, like cities or landmarks.",
   "author": "Turf Authors",
   "license": "MIT",
   "bugs": {

diff --git a/packages/turf-ellipse/package.json b/packages/turf-ellipse/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@turf/ellipse",
   "version": "7.2.0",
-  "description": "turf ellipse module",
+  "description": "Takes a Point and calculates the ellipse polygon given two semi-axes expressed in variable units and steps for precision.",
   "author": "Turf Authors",
   "contributors": [
     "Moacir P. de Sá Pereira <@muziejus>"