Permalink
Browse files

polishing comments

  • Loading branch information...
1 parent d214925 commit f3409dc0a0b7f0ce009825f8df806b391ff770ec Neeraj Singh committed Jul 27, 2010
@@ -58,12 +58,12 @@ def to_formatted_s(format = :default)
alias_method :to_default_s, :to_s
alias_method :to_s, :to_formatted_s
- # Returns a string that represents this array in XML by sending +to_xml+
- # to each element. Active Record collections delegate their representation
+ # Returns a string that represents the array in XML by invoking +to_xml+
+ # on each element. Active Record collections delegate their representation
# in XML to this method.
#
# All elements are expected to respond to +to_xml+, if any of them does
- # not an exception is raised.
+ # not then an exception is raised.
#
# The root node reflects the class name of the first element in plural
# if all elements belong to the same type and that's not Hash:
@@ -115,8 +115,8 @@ def to_formatted_s(format = :default)
# <?xml version="1.0" encoding="UTF-8"?>
# <projects type="array"/>
#
- # By default root children have as node name the one of the root
- # singularized. You can change it with the <tt>:children</tt> option.
+ # By default name of the node for the children of root is <tt>root.singularize</tt>.
+ # You can change it with the <tt>:children</tt> option.
#
# The +options+ hash is passed downwards:
#
@@ -1,14 +1,14 @@
require 'active_support/core_ext/object/duplicable'
require 'active_support/core_ext/array/extract_options'
-# Retain for backward compatibility. Methods are now included in Class.
+# Retained for backward compatibility. Methods are now included in Class.
module ClassInheritableAttributes # :nodoc:
end
-# Allows attributes to be shared within an inheritance hierarchy, but where each descendant gets a copy of
+# Allows attributes to be shared within an inheritance hierarchy. Each descendant gets a copy of
# their parents' attributes, instead of just a pointer to the same. This means that the child can add elements
# to, for example, an array without those additions being shared with either their parent, siblings, or
-# children, which is unlike the regular class-level attributes that are shared across the entire hierarchy.
+# children. This is unlike the regular class-level attributes that are shared across the entire hierarchy.
#
# The copies of inheritable parent attributes are added to subclasses when they are created, via the
# +inherited+ hook.

0 comments on commit f3409dc

Please sign in to comment.