Skip to content

Commit

Permalink
copy-edits some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fxn committed Jul 8, 2010
1 parent 4a1207d commit a958793
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 22 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -103,15 +103,14 @@ def column_exists?(table_name, column_name, type = nil, options = {})
# The +options+ hash can include the following keys:
# [<tt>:id</tt>]
# Whether to automatically add a primary key column. Defaults to true.
# Join tables for +has_and_belongs_to_many+ should set <tt>:id => false</tt>.
# Join tables for +has_and_belongs_to_many+ should set it to false.
# [<tt>:primary_key</tt>]
# The name of the primary key, if one is to be added automatically.
# Defaults to +id+. You must NOT pass :id => false otherwise :primary_key option
# will have no effect.
# Defaults to +id+. If <tt>:id</tt> is false this option is ignored.
#
# Also note that this just sets the primary_key in the table. You still need to
# add :set_primary_key => '' in the model to tell model what column is the
# primary_key. Models do NOT auto-detect the primary_key from table defintion.
# Also note that this just sets the primary key in the table. You additionally
# need to configure the primary key in the model via the +set_primary_key+ macro.
# Models do NOT auto-detect the primary key from their table definition.
#
# [<tt>:options</tt>]
# Any extra options you want appended to the table definition.
Expand Down
36 changes: 20 additions & 16 deletions railties/guides/source/active_support_core_extensions.textile
Original file line number Diff line number Diff line change
Expand Up @@ -1107,47 +1107,51 @@ If for whatever reason an application loads the definition of a mailer class and

NOTE: Defined in +active_support/core_ext/class/delegating_attributes.rb+.

h4. Descendants & Subclasses
h4. Subclasses & Descendants

h5. +descendants+
h5. +subclasses+

The +descendants+ method returns all classes, including its children, that inherits from self.
The +subclasses+ method returns the subclasses of the receiver:

<ruby>
class C; end
C.descendants #=> []
C.subclasses # => []

class B < C; end
C.descendants #=> [B]
C.subclasses # => [B]

class A < B; end
C.descendants #=> [B, A]
C.subclasses # => [B]

class D < C; end
C.descendants #=> [B, A, D]
C.subclasses # => [B, D]
</ruby>

h5. +subclasses+
The order in which these classes are returned is unspecified.

The +subclasses+ method returns all direct classes that inherits from self.
WARNING: This method is redefined in some Rails core classes but should be all compatible in Rails 3.1.

NOTE: Defined in +active_support/core_ext/class/subclasses.rb+.

h5. +descendants+

The +descendants+ method returns all classes that are <tt>&lt;</tt> than its receiver:

<ruby>
class C; end
C.subclasses #=> []
C.descendants # => []

class B < C; end
C.subclasses #=> [B]
C.descendants # => [B]

class A < B; end
C.subclasses #=> [B]
C.descendants # => [B, A]

class D < C; end
C.subclasses #=> [B, D]
C.descendants # => [B, A, D]
</ruby>

The order in which these class are returned is unspecified.

WARNING: This method is redefined in some Rails core classes but should be all compatible in Rails 3.1.
The order in which these classes are returned is unspecified.

NOTE: Defined in +active_support/core_ext/class/subclasses.rb+.

Expand Down

0 comments on commit a958793

Please sign in to comment.