From 428d47adfed8d6aa7b21aec2bf5ad890961c9de3 Mon Sep 17 00:00:00 2001 From: Yves Senn Date: Wed, 8 Jul 2015 12:16:16 +0200 Subject: applies new doc guidelines to Active Record. The focus of this change is to make the API more accessible. References to method and classes should be linked to make it easy to navigate around. This patch makes exzessiv use of `rdoc-ref:` to provide more readable docs. This makes it possible to document `ActiveRecord::Base#save` even though the method is within a separate module `ActiveRecord::Persistence`. The goal here is to bring the API closer to the actual code that you would write. This commit only deals with Active Record. The other gems will be updated accordingly but in different commits. The pass through Active Record is not completely finished yet. A follow up commit will change the spots I haven't yet had the time to update. /cc @fxn --- activerecord/lib/active_record/attribute_methods.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'activerecord/lib/active_record/attribute_methods.rb') diff --git a/activerecord/lib/active_record/attribute_methods.rb b/activerecord/lib/active_record/attribute_methods.rb index ca6ba18fe0..cbdd4950a6 100644 --- a/activerecord/lib/active_record/attribute_methods.rb +++ b/activerecord/lib/active_record/attribute_methods.rb @@ -96,7 +96,7 @@ module ActiveRecord end end - # Raises an ActiveRecord::DangerousAttributeError exception when an + # Raises an ActiveRecord::DangerousAttributeError exception when an # \Active \Record method is defined in the model, otherwise +false+. # # class Person < ActiveRecord::Base @@ -346,7 +346,7 @@ module ActiveRecord # # Note: +:id+ is always present. # - # Alias for the read_attribute method. + # Alias for the #read_attribute method. # # class Person < ActiveRecord::Base # belongs_to :organization @@ -364,7 +364,7 @@ module ActiveRecord end # Updates the attribute identified by attr_name with the specified +value+. - # (Alias for the protected write_attribute method). + # (Alias for the protected #write_attribute method). # # class Person < ActiveRecord::Base # end -- cgit v1.2.3