From 70bd43eba7bc1ebde699a36e351ae92307416ba0 Mon Sep 17 00:00:00 2001 From: M-Scott-Lassiter Date: Wed, 25 May 2022 14:21:19 -0700 Subject: [PATCH] api(isValidCoordinate): update returns description --- src/core/coordinates/validCoordinate.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/core/coordinates/validCoordinate.js b/src/core/coordinates/validCoordinate.js index 856c0b6..81c7e6d 100644 --- a/src/core/coordinates/validCoordinate.js +++ b/src/core/coordinates/validCoordinate.js @@ -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) {