From b98c0a365d793eb18e759d394fca0eb43fda420c Mon Sep 17 00:00:00 2001
From: Alex Reisner <alex@alexreisner.com>
Date: Thu, 24 Mar 2011 14:46:14 -0400
Subject: [PATCH] Change format of option lists in code comments.

---
 lib/geocoder/calculations.rb       |  2 +-
 lib/geocoder/orms/active_record.rb | 14 ++++++++------
 2 files changed, 9 insertions(+), 7 deletions(-)

diff --git a/lib/geocoder/calculations.rb b/lib/geocoder/calculations.rb
index dcfe3fd1..0152cbe0 100644
--- a/lib/geocoder/calculations.rb
+++ b/lib/geocoder/calculations.rb
@@ -24,7 +24,7 @@ module Geocoder
     # Calculate the 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>
+    # * <tt>:units</tt> - <tt>:mi</tt> (default) or <tt>:km</tt>
     #
     def distance_between(lat1, lon1, lat2, lon2, options = {})
 
diff --git a/lib/geocoder/orms/active_record.rb b/lib/geocoder/orms/active_record.rb
index 7b585940..1194f8dc 100644
--- a/lib/geocoder/orms/active_record.rb
+++ b/lib/geocoder/orms/active_record.rb
@@ -53,12 +53,14 @@ module Geocoder::Orm
       # records within a radius (in miles) of the given point.
       # Options hash may include:
       #
-      # +units+   :: <tt>:mi</tt> (default) or <tt>:km</tt>
-      # +exclude+ :: an object to exclude (used by the #nearbys method)
-      # +order+   :: column(s) for ORDER BY SQL clause
-      # +limit+   :: number of records to return (for LIMIT SQL clause)
-      # +offset+  :: number of records to skip (for OFFSET SQL clause)
-      # +select+  :: string with the SELECT SQL fragment (e.g. “id, name”)
+      # * +:units+   - <tt>:mi</tt> (default) or <tt>:km</tt>; to be used
+      #   for interpreting radius as well as the +distance+ attribute which
+      #   is added to each found nearby object
+      # * +:select+  - string with the SELECT SQL fragment (e.g. “id, name”)
+      # * +:order+   - column(s) for ORDER BY SQL clause
+      # * +:limit+   - number of records to return (for LIMIT SQL clause)
+      # * +:offset+  - number of records to skip (for OFFSET SQL clause)
+      # * +:exclude+ - an object to exclude (used by the +nearbys+ method)
       #
       def near_scope_options(latitude, longitude, radius = 20, options = {})
         radius *= Geocoder::Calculations.km_in_mi if options[:units] == :km
-- 
GitLab