made a pass to the docs of :negative_format

rails · Nov 3, 2010 · 208fb29 · 208fb29
1 parent c4d977f
commit 208fb29
Showing 1 changed file with 7 additions and 5 deletions.
diff --git a/actionpack/lib/action_view/helpers/number_helper.rb b/actionpack/lib/action_view/helpers/number_helper.rb
@@ -86,11 +86,13 @@ def number_to_phone(number, options = {})
       # * <tt>:unit</tt>             - Sets the denomination of the currency (defaults to "$").
       # * <tt>:separator</tt>        - Sets the separator between the units (defaults to ".").
       # * <tt>:delimiter</tt>        - Sets the thousands delimiter (defaults to ",").
-      # * <tt>:format</tt>           - Sets the format of the output string (defaults to "%u%n").
+      # * <tt>:format</tt>           - Sets the format for non-negative numbers (defaults to "%u%n").
-      # * <tt>:negative_format</tt>  - Sets the format of the output string (defaults to "-" + :format). The field types are:
+      #                                Fields are <tt>%u</tt> for the currency, and <tt>%n</tt>
-      #
+      #                                for the number.
-      #     %u  The currency unit
+      # * <tt>:negative_format</tt>  - Sets the format for negative numbers (defaults to prepending
-      #     %n  The number
+      #                                an hyphen to the formatted number given by <tt>:format</tt>).
+      #                                Accepts the same fields than <tt>:format</tt>, except
+      #                                <tt>%n</tt> is here the absolute value of the number.
       #
       # ==== Examples
       #  number_to_currency(1234567890.50)                    # => $1,234,567,890.50