From c5bd2318be0395b7f90c39a29d671c955d1a5d49 Mon Sep 17 00:00:00 2001 From: Xavier Noria Date: Tue, 27 May 2008 23:53:21 +0200 Subject: small fix in ActiveResource::Base docs --- activeresource/lib/active_resource/base.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'activeresource/lib') diff --git a/activeresource/lib/active_resource/base.rb b/activeresource/lib/active_resource/base.rb index 463ee9f1e7..26931e5e4a 100644 --- a/activeresource/lib/active_resource/base.rb +++ b/activeresource/lib/active_resource/base.rb @@ -200,7 +200,7 @@ module ActiveResource cattr_accessor :logger class << self - # Gets the URI of the REST resources to map for this class. The site variable is required + # Gets the URI of the REST resources to map for this class. The site variable is required for # Active Resource's mapping to work. def site # Not using superclass_delegating_reader because don't want subclasses to modify superclass instance @@ -226,7 +226,7 @@ module ActiveResource end # Sets the URI of the REST resources to map for this class to the value in the +site+ argument. - # The site variable is required Active Resource's mapping to work. + # The site variable is required for Active Resource's mapping to work. def site=(site) @connection = nil if site.nil? -- cgit v1.2.3 From 7ac40187864c5a9d1837fb59dea170acd30699c5 Mon Sep 17 00:00:00 2001 From: Xavier Noria Date: Tue, 27 May 2008 23:58:45 +0200 Subject: Active Resource instance -> ActiveResource::Base instance --- activeresource/lib/active_resource/custom_methods.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'activeresource/lib') diff --git a/activeresource/lib/active_resource/custom_methods.rb b/activeresource/lib/active_resource/custom_methods.rb index 4c8699288c..770116ceb7 100644 --- a/activeresource/lib/active_resource/custom_methods.rb +++ b/activeresource/lib/active_resource/custom_methods.rb @@ -48,8 +48,8 @@ module ActiveResource # # => [{:id => 1, :name => 'Ryan'}] # # Note: the objects returned from this method are not automatically converted - # into Active Resource instances - they are ordinary Hashes. If you are expecting - # Active Resource instances, use the find class method with the + # into ActiveResource::Base instances - they are ordinary Hashes. If you are expecting + # ActiveResource::Base instances, use the find class method with the # :from option. For example: # # Person.find(:all, :from => :active) -- cgit v1.2.3 From 4be3c2c92fed516aca2fcb1ba9fc253bda580d25 Mon Sep 17 00:00:00 2001 From: Nick Plante Date: Tue, 27 May 2008 23:21:34 -0400 Subject: fix spelling error --- activeresource/lib/active_resource/base.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'activeresource/lib') diff --git a/activeresource/lib/active_resource/base.rb b/activeresource/lib/active_resource/base.rb index 26931e5e4a..82aa133bb1 100644 --- a/activeresource/lib/active_resource/base.rb +++ b/activeresource/lib/active_resource/base.rb @@ -298,7 +298,7 @@ module ActiveResource @timeout = timeout end - # Gets tthe number of seconds after which requests to the REST API should time out. + # Gets the number of seconds after which requests to the REST API should time out. def timeout if defined?(@timeout) @timeout -- cgit v1.2.3 From a8e32152fcd07786fc6b0a58d999267bc3ddec04 Mon Sep 17 00:00:00 2001 From: Nick Plante Date: Tue, 27 May 2008 23:32:47 -0400 Subject: update language and use proper fonts for method names --- activeresource/lib/active_resource/base.rb | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'activeresource/lib') diff --git a/activeresource/lib/active_resource/base.rb b/activeresource/lib/active_resource/base.rb index 82aa133bb1..253d336dc9 100644 --- a/activeresource/lib/active_resource/base.rb +++ b/activeresource/lib/active_resource/base.rb @@ -426,16 +426,16 @@ module ActiveResource alias_method :set_primary_key, :primary_key= #:nodoc: - # Create a new resource instance and request to the remote service + # Creates a new resource instance and makes a request to the remote service # that it be saved, making it equivalent to the following simultaneous calls: # # ryan = Person.new(:first => 'ryan') # ryan.save # - # The newly created resource is returned. If a failure has occurred an - # exception will be raised (see save). If the resource is invalid and - # has not been saved then valid? will return false, - # while new? will still return true. + # Returns the newly created resource. If a failure has occurred an + # exception will be raised (see save). If the resource is invalid and + # has not been saved then valid? will return false, + # while new? will still return true. # # ==== Examples # Person.create(:name => 'Jeremy', :email => 'myname@nospam.com', :enabled => true) -- cgit v1.2.3