From a62f7220bbad1678dbf114e2f252172e76b44bab Mon Sep 17 00:00:00 2001
From: Emilio Tagua <miloops@gmail.com>
Date: Thu, 7 Oct 2010 16:27:00 -0300
Subject: Add docs to Identity Map.

---
 activerecord/lib/active_record/identity_map.rb | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'activerecord/lib/active_record')

diff --git a/activerecord/lib/active_record/identity_map.rb b/activerecord/lib/active_record/identity_map.rb
index 6bf77c71fa..94eece9132 100644
--- a/activerecord/lib/active_record/identity_map.rb
+++ b/activerecord/lib/active_record/identity_map.rb
@@ -1,4 +1,17 @@
 module ActiveRecord
+  # = Active Record Identity Map
+  #
+  # Ensures that each object gets loaded only once by keeping every loaded
+  # object in a map. Looks up objects using the map when referring to them.
+  #
+  # More information on Identity Map pattern:
+  #   http://www.martinfowler.com/eaaCatalog/identityMap.html
+  #
+  # == Configuration
+  #
+  # In order to activate IdentityMap, set <tt>config.active_record.identity_map = true</tt>
+  # in your <tt>config/application.rb</tt> file.
+  #
   module IdentityMap
     extend ActiveSupport::Concern
 
-- 
cgit v1.2.3