Add documentation for index_type argument to add_index method for migrations...

Add documentation for index_type argument to add_index method for migrations #2005 [blaine@odeo.com]

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@2100 5ecf4fe2-1ee6-0310-87b1-e25e094e27de

activerecord/CHANGELOG

 *SVN*
 
+* Add documentation for index_type argument to add_index method for migrations #2005 [blaine@odeo.com]
+
 * Modify read_attribute to allow a symbol argument #2024 [Ken Kunz]
 
 * Make destroy return self #1913 [sebastian.kanthak@muehlheim.de]

activerecord/lib/active_record/migration.rb

@@ -63,7 +63,7 @@ class IrreversibleMigration < ActiveRecordError#:nodoc:
   # * <tt>change_column(table_name, column_name, type, options)</tt>:  Changes the column to a different type using the same
   #   parameters as add_column.
   # * <tt>remove_column(table_name, column_name)</tt>: Removes the column named +column_name+ from the table called +table_name+.
-  # * <tt>add_index(table_name, column_name)</tt>: Add a new index with the name of the column on the column.
+  # * <tt>add_index(table_name, column_name, index_type)</tt>: Add a new index with the name of the column on the column. Specify an optional index_type (e.g. UNIQUE).
   # * <tt>remove_index(table_name, column_name)</tt>: Remove the index called the same as the column.
   #
   # == Irreversible transformations