From b3b13a451aa0d77638e24a0c5dffa3d466f8fb08 Mon Sep 17 00:00:00 2001
From: Alex Reisner <alex@alexreisner.com>
Date: Fri, 1 Apr 2011 01:16:15 -0400
Subject: [PATCH] Clean up code comments.
---
lib/geocoder/calculations.rb | 12 +++++-------
1 file changed, 5 insertions(+), 7 deletions(-)
diff --git a/lib/geocoder/calculations.rb b/lib/geocoder/calculations.rb
index 6c180030..bd0ed118 100644
--- a/lib/geocoder/calculations.rb
+++ b/lib/geocoder/calculations.rb
@@ -22,24 +22,22 @@ module Geocoder
KM_IN_MI = 0.621371192
##
- # Calculate the distance spanned by one
- # degree of latitude in the given units.
+ # Distance spanned by one degree of latitude in the given units.
#
def latitude_degree_distance(units = :mi)
2 * Math::PI * earth_radius(units) / 360
end
##
- # Calculate the distance spanned by one degree of longitude
- # at the given latitude. This ranges from around 69 miles at
- # the equator to zero at the poles.
+ # Distance spanned by one degree of longitude at the given latitude.
+ # This ranges from around 69 miles at the equator to zero at the poles.
#
def longitude_degree_distance(latitude, units = :mi)
latitude_degree_distance(units) * Math.cos(to_radians(latitude))
end
##
- # Calculate the distance between two points on Earth (Haversine formula).
+ # Distance between two points on Earth (Haversine formula).
# Takes two sets of coordinates and an options hash:
#
# * <tt>:units</tt> - <tt>:mi</tt> (default) or <tt>:km</tt>
@@ -63,7 +61,7 @@ module Geocoder
end
##
- # Calculate bearing between two sets of coordinates.
+ # Bearing between two points on Earth.
# Returns a number of degrees from due north (clockwise).
#
# Also accepts an options hash:
--
GitLab