Docs for #defaults

tj · Oct 8, 2009 · 39e80d6 · 39e80d6
1 parent 46ca37c
commit 39e80d6
Showing 1 changed file with 12 additions and 8 deletions.
diff --git a/lib/dm-pagination/defaults.rb b/lib/dm-pagination/defaults.rb
@@ -18,14 +18,18 @@ module Pagination
     #
     # === Options
     #
-    #   :per_page              Records per page; defaults to 6
+    #   :per_page       Records per page; defaults to 6
-    #   :size                  Number of intermediate page number links to be shown; Defaults to 7
+    #   :size           Number of intermediate page number links to be shown; Defaults to 7
-    #   :pager_class           Class for the div that contains the pagination links, defaults to 'pager'
+    #   :pager_class    Class for the div that contains the pagination links, defaults to 'pager'
-    #   :previous_text         Text for the 'previous' link, defaults to 'Previous'
+    #   :previous_text  Text for the 'previous' link, defaults to 'Previous'
-    #   :next_text             Text for the 'next' link, defaults to 'Next'
+    #   :next_text      Text for the 'next' link, defaults to 'Next'
-    #   :first_text            Text for the 'first' link, defaults to 'First'
+    #   :first_text     Text for the 'first' link, defaults to 'First'
-    #   :last_text             Text for the 'last' link, defaults to 'Last'
+    #   :last_text      Text for the 'last' link, defaults to 'Last'
-    #   :more_text             Text for the 'more' indicator, defaults to '...'
+    #   :more_text      Text for the 'more' indicator, defaults to '...'
+    #
+    # === Examples
+    #
+    #   DataMapper::Pagination.defaults[:size] = 5
     #
 
     def self.defaults