add doc for search array

kovacs · Jul 1, 2009 · c2863ec · c2863ec
1 parent 604dd9e
commit c2863ec
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lib/sortable.rb b/lib/sortable.rb
@@ -91,6 +91,12 @@ module ClassMethods
       #   
       #   and the table is now sortable by a related object's column and is the default sort value for the table.
       #
+      # Search. You can specify what columns are searchable on your objects as follows:
+      #   :search_array => ['cablecar_users.username', 'cablecar_users.name']
+      # 
+      # Now search queries will only search username and name for users. By default search is enabled for all columns
+      # that are being displayed in the table. This allows you to expand or constrain those values.
+      #
       def sortable_table(klass, options={})
         @@sortable_table_options ||={}