From 0e3fd4e79e7ec32600ddd98112eefea73f3de1a0 Mon Sep 17 00:00:00 2001
From: Alex Reisner <alex@alexreisner.com>
Date: Sun, 23 Dec 2012 11:10:42 -0500
Subject: [PATCH] Improve code comment.
---
lib/geocoder/configuration.rb | 20 ++++++++------------
1 file changed, 8 insertions(+), 12 deletions(-)
diff --git a/lib/geocoder/configuration.rb b/lib/geocoder/configuration.rb
index 71811e81..dc5d4222 100644
--- a/lib/geocoder/configuration.rb
+++ b/lib/geocoder/configuration.rb
@@ -4,7 +4,14 @@ require 'geocoder/configuration_hash'
module Geocoder
##
- # Provides convenient access to the Configuration singleton.
+ # Configuration options should be set by passing a hash:
+ #
+ # Geocoder.configure(
+ # :timeout => 5,
+ # :lookup => :yandex,
+ # :api_key => "2a9fsa983jaslfj982fjasd",
+ # :units => :km
+ # )
#
def self.configure(options = nil, &block)
if block_given?
@@ -37,17 +44,6 @@ module Geocoder
data
end
- ##
- # Configuration options should be set by passing a hash to
- # the configure method:
- #
- # Geocoder.configure(
- # :timeout => 5,
- # :lookup => :yandex,
- # :api_key => "2a9fsa983jaslfj982fjasd",
- # :units => :km
- # )
- #
class Configuration
include Singleton
--
GitLab