Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

`floatformat` template filter docstring changes:

 * Split example cases.
 * Corrected use with negative arguments (quotes are needed).
 * Added another example of a number that has decimal places that include a non-zero digit and that ends with zeros.


git-svn-id: http://code.djangoproject.com/svn/django/trunk@6646 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 72b7a33929dd6f61ad8d62152ac800d5501778da 1 parent 75efa28
@gdub gdub authored
Showing with 22 additions and 13 deletions.
  1. +22 −13 django/template/defaultfilters.py
View
35 django/template/defaultfilters.py
@@ -54,22 +54,31 @@ def fix_ampersands(value):
def floatformat(text, arg=-1):
"""
- If called without an argument, displays a floating point
- number as 34.2 -- but only if there's a point to be displayed.
- With a positive numeric argument, it displays that many decimal places
- always.
- With a negative numeric argument, it will display that many decimal
- places -- but only if there's places to be displayed.
- Examples:
+ Displays a float to a specified number of decimal places.
+
+ If called without an argument, it displays the floating point number with
+ one decimal place -- but only if there's a decimal place to be displayed:
* num1 = 34.23234
* num2 = 34.00000
- * num1|floatformat results in 34.2
- * num2|floatformat is 34
- * num1|floatformat:3 is 34.232
- * num2|floatformat:3 is 34.000
- * num1|floatformat:-3 is 34.232
- * num2|floatformat:-3 is 34
+ * num3 = 34.26000
+ * {{ num1|floatformat }} displays "34.2"
+ * {{ num2|floatformat }} displays "34"
+ * {{ num3|floatformat }} displays "34.3"
+
+ If arg is positive, it will always display exactly arg number of decimal
+ places:
+
+ * {{ num1|floatformat:3 }} displays "34.232"
+ * {{ num2|floatformat:3 }} displays "34.000"
+ * {{ num3|floatformat:3 }} displays "34.260"
+
+ If arg is negative, it will display arg number of decimal places -- but
+ only if there are places to be displayed:
+
+ * {{ num1|floatformat:"-3" }} displays "34.232"
+ * {{ num2|floatformat:"-3" }} displays "34"
+ * {{ num3|floatformat:"-3" }} displays "34.260"
"""
try:
f = float(text)
Please sign in to comment.
Something went wrong with that request. Please try again.