From cf1028bbf17ff35a4f00d5178a1515577e971462 Mon Sep 17 00:00:00 2001 From: Anton Maminov Date: Thu, 11 Apr 2024 16:13:29 +0300 Subject: [PATCH] update comments --- README.md | 2 +- src/ring_area.cr | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fcdbc36..94ccfcb 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ coordinates = [ RingArea.ring_area(coordinates) # => 7748891609977.456 ``` -Accepts an `Array(Array(Number))` of Ring Coordinates. +Accepts an `Array(Array(Number))` of Ring Coordinates as `[[longitude1, latitude1], [longitude2, latitude2], ...]`. Returns the approximate signed geodesic area of the polygon in square meters. diff --git a/src/ring_area.cr b/src/ring_area.cr index 550d875..8024dc9 100644 --- a/src/ring_area.cr +++ b/src/ring_area.cr @@ -20,7 +20,7 @@ module RingArea # JPL Publication 07-03, Jet Propulsion # Laboratory, Pasadena, CA, June 2007 https://trs.jpl.nasa.gov/handle/2014/40409 # - # `coords` - Ring Coordinates as [[longitude, latitude], ...] + # `coords` - Ring Coordinates as `[[longitude1, latitude1], [longitude2, latitude2], ...]` # # Return the approximate signed geodesic area of the polygon in square meters. #