pass over the code comments

* Highlights the requirement of an attributes method.
* Removes some details that depend on the implementation of the class including the module.
* Applies guidelines here and there.

1 files changed, 32 insertions, 28 deletions

diff --git a/activemodel/lib/active_model/attribute_methods.rb b/activemodel/lib/active_model/attribute_methods.rb
index 6d11c0fbdc..5db898b33a 100644
--- a/activemodel/lib/active_model/attribute_methods.rb
+++ b/activemodel/lib/active_model/attribute_methods.rb
@@ -12,19 +12,21 @@ module ActiveModel
   #   # => ActiveModel::MissingAttributeError: missing attribute: user_id
   class MissingAttributeError < NoMethodError
   end
+
   # == Active \Model Attribute Methods
   #
   # <tt>ActiveModel::AttributeMethods</tt> provides a way to add prefixes and
-  # suffixes to your methods as well as handling the creation of Active Record
-  # like class methods such as +table_name+.
+  # suffixes to your methods as well as handling the creation of
+  # <tt>ActiveRecord::Base</tt>-like class methods such as +table_name+.
   #
-  # The requirements to implement ActiveModel::AttributeMethods are to:
+  # The requirements to implement <tt>ActiveModel::AttributeMethods</tt> are to:
   #
-  # * <tt>include ActiveModel::AttributeMethods</tt> in your object.
-  # * Call each Attribute Method module method you want to add, such as
-  #   +attribute_method_suffix+ or +attribute_method_prefix+.
+  # * <tt>include ActiveModel::AttributeMethods</tt> in your class.
+  # * Call each of its method you want to add, such as +attribute_method_suffix+
+  #   or +attribute_method_prefix+.
   # * Call +define_attribute_methods+ after the other methods are called.
   # * Define the various generic +_attribute+ methods that you have declared.
+  # * Define an +attributes+ method, see below.
   #
   # A minimal implementation could be:
   #
@@ -38,6 +40,10 @@ module ActiveModel
   #
   #     attr_accessor :name
   #
+  #     def attributes
+  #       {'name' => @name}
+  #     end
+  #
   #     private
   #
   #     def attribute_contrived?(attr)
@@ -53,10 +59,10 @@ module ActiveModel
   #     end
   #   end
   #
-  # Note that whenever you include ActiveModel::AttributeMethods in your class,
-  # it requires you to implement an +attributes+ method which returns a hash
-  # with each attribute name in your model as hash key and the attribute value as
-  # hash value.
+  # Note that whenever you include <tt>ActiveModel::AttributeMethods</tt> in
+  # your class, it requires you to implement an +attributes+ method which
+  # returns a hash with each attribute name in your model as hash key and the
+  # attribute value as hash value.
   #
   # Hash keys must be strings.
   module AttributeMethods
@@ -179,7 +185,6 @@ module ActiveModel
         undefine_attribute_methods
       end
 
-
       # Allows you to make aliases for attributes.
       #
       #   class Person
@@ -413,17 +418,16 @@ module ActiveModel
         end
     end
 
-    # Allows access to the object attributes, which are held in the
-    # <tt>@attributes</tt> hash, as though they were first-class methods. So a
-    # Person class with a name attribute can use Person#name and Person#name=
-    # and never directly use the attributes hash -- except for multiple assigns
-    # with ActiveRecord#attributes=. A Milestone class can also ask
-    # Milestone#completed? to test that the completed attribute is not +nil+
-    # or 0.
+    # Allows access to the object attributes, which are held in the hash
+    # returned by <tt>attributes</tt>, as though they were first-class
+    # methods. So a +Person+ class with a +name+ attribute can for example use
+    # <tt>Person#name</tt> and <tt>Person#name=</tt> and never directly use
+    # the attributes hash -- except for multiple assigns with
+    # <tt>ActiveRecord::Base#attributes=</tt>.
     #
-    # It's also possible to instantiate related objects, so a Client class
-    # belonging to the clients table with a +master_id+ foreign key can
-    # instantiate master through Client#master.
+    # It's also possible to instantiate related objects, so a <tt>Client</tt>
+    # class belonging to the +clients+ table with a +master_id+ foreign key
+    # can instantiate master through <tt>Client#master</tt>.
     def method_missing(method, *args, &block)
       if respond_to_without_attributes?(method, true)
         super
@@ -433,17 +437,17 @@ module ActiveModel
       end
     end
 
-    # attribute_missing is like method_missing, but for attributes. When method_missing is
-    # called we check to see if there is a matching attribute method. If so, we call
-    # attribute_missing to dispatch the attribute. This method can be overloaded to
-    # customize the behavior.
+    # +attribute_missing+ is like +method_missing+, but for attributes. When
+    # +method_missing+ is called we check to see if there is a matching
+    # attribute method. If so, we tell +attribute_missing+ to dispatch the
+    # attribute. This method can be overloaded to customize the behavior.
     def attribute_missing(match, *args, &block)
       __send__(match.target, match.attr_name, *args, &block)
     end
 
-    # A Person object with a name attribute can ask <tt>person.respond_to?(:name)</tt>,
-    # <tt>person.respond_to?(:name=)</tt>, and <tt>person.respond_to?(:name?)</tt>
-    # which will all return +true+.
+    # A +Person+ instance with a +name+ attribute can ask
+    # <tt>person.respond_to?(:name)</tt>, <tt>person.respond_to?(:name=)</tt>,
+    # and <tt>person.respond_to?(:name?)</tt> which will all return +true+.
     alias :respond_to_without_attributes? :respond_to?
     def respond_to?(method, include_private_methods = false)
       if super