aboutsummaryrefslogtreecommitdiffstats
path: root/activerecord/lib/active_record/migration.rb
diff options
context:
space:
mode:
authorLucia Escanellas <raviolicode@gmail.com>2011-06-17 15:55:07 -0300
committerLucia Escanellas <raviolicode@gmail.com>2011-06-17 16:30:40 -0300
commit144a388dec5ae906e8a6900f37706e795188b066 (patch)
tree089d40eb5bd1da44b8ea7bd0c6aeb96dff165dd6 /activerecord/lib/active_record/migration.rb
parent6ca18f9037b8ce86d9fd3e19be754cc3f97de0fd (diff)
downloadrails-144a388dec5ae906e8a6900f37706e795188b066.tar.gz
rails-144a388dec5ae906e8a6900f37706e795188b066.tar.bz2
rails-144a388dec5ae906e8a6900f37706e795188b066.zip
Update remove_index documentation
* Changes should better reflect present code behavior * Related to issue: https://github.com/rails/rails/issues/1624
Diffstat (limited to 'activerecord/lib/active_record/migration.rb')
-rw-r--r--activerecord/lib/active_record/migration.rb6
1 files changed, 4 insertions, 2 deletions
diff --git a/activerecord/lib/active_record/migration.rb b/activerecord/lib/active_record/migration.rb
index de26b21f1a..3d1bc5c1e0 100644
--- a/activerecord/lib/active_record/migration.rb
+++ b/activerecord/lib/active_record/migration.rb
@@ -116,8 +116,10 @@ module ActiveRecord
# with the name of the column. Other options include
# <tt>:name</tt> and <tt>:unique</tt> (e.g.
# <tt>{ :name => "users_name_index", :unique => true }</tt>).
- # * <tt>remove_index(table_name, index_name)</tt>: Removes the index specified
- # by +index_name+.
+ # * <tt>remove_index(table_name, :column => column_name)</tt>: Removes the index
+ # specified by +column_name+.
+ # * <tt>remove_index(table_name, :name => index_name)</tt>: Removes the index
+ # specified by +index_name+.
#
# == Irreversible transformations
#