Skip to content
Snippets Groups Projects
Commit 0e3fd4e7 authored by Alex Reisner's avatar Alex Reisner
Browse files

Improve code comment.

parent 75a270a6
No related branches found
No related tags found
No related merge requests found
...@@ -4,7 +4,14 @@ require 'geocoder/configuration_hash' ...@@ -4,7 +4,14 @@ require 'geocoder/configuration_hash'
module Geocoder 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) def self.configure(options = nil, &block)
if block_given? if block_given?
...@@ -37,17 +44,6 @@ module Geocoder ...@@ -37,17 +44,6 @@ module Geocoder
data data
end 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 class Configuration
include Singleton include Singleton
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment