Skip to content

Commit

Permalink
api(isValidCoordinate): update returns description
Browse files Browse the repository at this point in the history
  • Loading branch information
M-Scott-Lassiter committed May 25, 2022
1 parent 7e3e8ed commit 70bd43e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/core/coordinates/validCoordinate.js
Expand Up @@ -7,7 +7,7 @@ const { valid3DCoordinate } = require('./valid3DCoordinate')
* @memberof Core.Coordinates
* @see https://github.com/M-Scott-Lassiter/jest-geojson/issues/4
* @param {GeoJSON2DCoordinate|GeoJSON3DCoordinate} coordinate A WGS-84 array of [longitude, latitude] or [longitude, latitude, alititude]
* @returns {boolean} True if a valid 3D GeoJSON coordinate. If invalid, it will throw an error.
* @returns {boolean} True if a valid 2D or 3D GeoJSON coordinate. If invalid, it will throw an error.
* @throws {Error} Input must be an array of only two or three elments
*/
function validCoordinate(coordinate) {
Expand Down

0 comments on commit 70bd43e

Please sign in to comment.