From 236c736d5aadd243e22228d33348b742fcbdf524 Mon Sep 17 00:00:00 2001
From: Alex Reisner <alex@alexreisner.com>
Date: Thu, 4 Oct 2012 10:28:50 -0400
Subject: [PATCH] Improve code comments.
---
lib/geocoder/results/base.rb | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/lib/geocoder/results/base.rb b/lib/geocoder/results/base.rb
index 8a42413f..a798ced6 100644
--- a/lib/geocoder/results/base.rb
+++ b/lib/geocoder/results/base.rb
@@ -1,10 +1,16 @@
module Geocoder
module Result
class Base
- attr_accessor :data, :cache_hit
+
+ # data (hash) fetched from geocoding service
+ attr_accessor :data
+
+ # true if result came from cache, false if from request to geocoding
+ # service; nil if cache is not configured
+ attr_accessor :cache_hit
##
- # Takes a hash of result data from a parsed Google result document.
+ # Takes a hash of data from a parsed geocoding service response.
#
def initialize(data)
@data = data
--
GitLab