lib/picky/index/base.rb in picky-2.5.0 vs lib/picky/index/base.rb in picky-2.5.1

@@ -216,12 +216,10 @@
     end
     alias define_source source
 
     # Define a key_format on the index.
     #
-    # Parameter is a source, either one of the standard sources or
-    # anything responding to #each and returning objects that
-    # respond to id and the category names (or the category from option).
+    # Parameter is a method name to use on the key (e.g. :to_i, :to_s, :strip).
     #
     def key_format key_format
       internal_indexing.define_key_format key_format
     end
     alias define_key_format key_format
\ No newline at end of file