api: update JSDoc descriptions of coordinate core functions

M-Scott-Lassiter · May 25, 2022 · f5658f3 · f5658f3
1 parent ddc6472
commit f5658f3
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/src/core/coordinates/valid2DCoordinate.js b/src/core/coordinates/valid2DCoordinate.js
@@ -1,5 +1,5 @@
 /**
- * A helper function used to verify a coordinate has appropriate longitude and latitude values.
+ * Verifies a two element coordinate meets WGS-84 and GeoJSON validity requirements.
  *
  * @memberof Core.Coordinates
  * @see https://github.com/M-Scott-Lassiter/jest-geojson/issues/1

diff --git a/src/core/coordinates/valid3DCoordinate.js b/src/core/coordinates/valid3DCoordinate.js
@@ -1,7 +1,7 @@
 const { valid2DCoordinate } = require('./valid2DCoordinate')
 
 /**
- * A helper function used to verify a coordinate has appropriate longitude, latitude, and altitude values.
+ * Verifies a three element coordinate meets WGS-84 and GeoJSON validity requirements.
  *
  * @memberof Core.Coordinates
  * @see https://github.com/M-Scott-Lassiter/jest-geojson/issues/2

diff --git a/src/core/coordinates/validCoordinate.js b/src/core/coordinates/validCoordinate.js
@@ -2,7 +2,7 @@ const { valid2DCoordinate } = require('./valid2DCoordinate')
 const { valid3DCoordinate } = require('./valid3DCoordinate')
 
 /**
- * A helper function used to verify a coordinate has appropriate longitude, latitude, and altitude values.
+ * Verifies a two or three element coordinate meets WGS-84 and GeoJSON validity requirements.
  *
  * @memberof Core.Coordinates
  * @see https://github.com/M-Scott-Lassiter/jest-geojson/issues/4