Document Paperclip::Schema

thoughtbot · Dec 12, 2011 · f3eacd2 · f3eacd2
1 parent e0a6732
commit f3eacd2
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lib/paperclip/schema.rb b/lib/paperclip/schema.rb
@@ -1,4 +1,10 @@
 module Paperclip
+  # Provides two helpers that can be used in migrations.
+  #
+  # In order to use this module, the target class should implement a
+  # +column+ method that takes the column name and type, both as symbols,
+  # as well as a +remove_column+ method that takes a table and column name,
+  # also both symbols.
   module Schema
     @@columns = {:file_name    => :string,
                  :content_type => :string,