From 5c9d1dbb5c89ad6e685a5b20f89e97b2030ed282 Mon Sep 17 00:00:00 2001 From: Xavier Noria Date: Mon, 28 Jul 2008 22:10:38 +0200 Subject: escaping otherwise autolinked "scopes" in named_scope.rb (we can now assume rdoc is v2.1) --- activerecord/lib/active_record/named_scope.rb | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/activerecord/lib/active_record/named_scope.rb b/activerecord/lib/active_record/named_scope.rb index 69139900f2..7f274543b6 100644 --- a/activerecord/lib/active_record/named_scope.rb +++ b/activerecord/lib/active_record/named_scope.rb @@ -1,10 +1,10 @@ module ActiveRecord module NamedScope - # All subclasses of ActiveRecord::Base have two named_scopes: + # All subclasses of ActiveRecord::Base have two named \scopes: # * all - which is similar to a find(:all) query, and - # * scoped - which allows for the creation of anonymous scopes, on the fly: Shirt.scoped(:conditions => {:color => 'red'}).scoped(:include => :washing_instructions) + # * scoped - which allows for the creation of anonymous \scopes, on the fly: Shirt.scoped(:conditions => {:color => 'red'}).scoped(:include => :washing_instructions) # - # These anonymous scopes tend to be useful when procedurally generating complex queries, where passing + # These anonymous \scopes tend to be useful when procedurally generating complex queries, where passing # intermediate values (scopes) around as first-class objects is convenient. def self.included(base) base.class_eval do @@ -32,14 +32,14 @@ module ActiveRecord # Unlike Shirt.find(...), however, the object returned by Shirt.red is not an Array; it resembles the association object # constructed by a has_many declaration. For instance, you can invoke Shirt.red.find(:first), Shirt.red.count, # Shirt.red.find(:all, :conditions => {:size => 'small'}). Also, just - # as with the association objects, named scopes act like an Array, implementing Enumerable; Shirt.red.each(&block), + # as with the association objects, named \scopes act like an Array, implementing Enumerable; Shirt.red.each(&block), # Shirt.red.first, and Shirt.red.inject(memo, &block) all behave as if Shirt.red really was an Array. # - # These named scopes are composable. For instance, Shirt.red.dry_clean_only will produce all shirts that are both red and dry clean only. + # These named \scopes are composable. For instance, Shirt.red.dry_clean_only will produce all shirts that are both red and dry clean only. # Nested finds and calculations also work with these compositions: Shirt.red.dry_clean_only.count returns the number of garments # for which these criteria obtain. Similarly with Shirt.red.dry_clean_only.average(:thread_count). # - # All scopes are available as class methods on the ActiveRecord::Base descendent upon which the scopes were defined. But they are also available to + # All \scopes are available as class methods on the ActiveRecord::Base descendent upon which the \scopes were defined. But they are also available to # has_many associations. If, # # class Person < ActiveRecord::Base @@ -49,7 +49,7 @@ module ActiveRecord # then elton.shirts.red.dry_clean_only will return all of Elton's red, dry clean # only shirts. # - # Named scopes can also be procedural. + # Named \scopes can also be procedural: # # class Shirt < ActiveRecord::Base # named_scope :colored, lambda { |color| @@ -59,7 +59,7 @@ module ActiveRecord # # In this example, Shirt.colored('puce') finds all puce shirts. # - # Named scopes can also have extensions, just as with has_many declarations: + # Named \scopes can also have extensions, just as with has_many declarations: # # class Shirt < ActiveRecord::Base # named_scope :red, :conditions => {:color => 'red'} do @@ -70,7 +70,7 @@ module ActiveRecord # end # # - # For testing complex named scopes, you can examine the scoping options using the + # For testing complex named \scopes, you can examine the scoping options using the # proxy_options method on the proxy itself. # # class Shirt < ActiveRecord::Base -- cgit v1.2.3