aboutsummaryrefslogtreecommitdiffstats
path: root/activerecord/lib/active_record/migration/command_recorder.rb
diff options
context:
space:
mode:
authorAaron Patterson <aaron.patterson@gmail.com>2010-11-19 11:34:42 -0800
committerAaron Patterson <aaron.patterson@gmail.com>2010-11-19 11:34:42 -0800
commita4d9b1d329ef897f6b23216b01cb510db35a37b5 (patch)
tree0d10011219516f2866c6fff0f74d881496845759 /activerecord/lib/active_record/migration/command_recorder.rb
parentdb32b545dadae7808c210cd7ceef949a620490f0 (diff)
downloadrails-a4d9b1d329ef897f6b23216b01cb510db35a37b5.tar.gz
rails-a4d9b1d329ef897f6b23216b01cb510db35a37b5.tar.bz2
rails-a4d9b1d329ef897f6b23216b01cb510db35a37b5.zip
adding documentation for reversible migrations
Diffstat (limited to 'activerecord/lib/active_record/migration/command_recorder.rb')
-rw-r--r--activerecord/lib/active_record/migration/command_recorder.rb12
1 files changed, 11 insertions, 1 deletions
diff --git a/activerecord/lib/active_record/migration/command_recorder.rb b/activerecord/lib/active_record/migration/command_recorder.rb
index fc669d2e89..d7e481905a 100644
--- a/activerecord/lib/active_record/migration/command_recorder.rb
+++ b/activerecord/lib/active_record/migration/command_recorder.rb
@@ -1,7 +1,17 @@
module ActiveRecord
class Migration
# ActiveRecord::Migration::CommandRecorder records commands done during
- # a migration and knows how to reverse those commands.
+ # a migration and knows how to reverse those commands. The CommandRecorder
+ # knows how to invert the following commands:
+ #
+ # * add_column
+ # * add_index
+ # * add_timestamp
+ # * create_table
+ # * remove_timestamps
+ # * rename_column
+ # * rename_index
+ # * rename_table
class CommandRecorder
attr_accessor :commands, :delegate