Merge pull request rails#53477 from JuanitoFatas/docs/number_to_friends [ci-skip]

p8 · web-flow · commit eda12e5319f2 · 2024-10-29T16:13:13.000+01:00
[Docs] Update working cases example outputs for number_to_* helpers
diff --git a/actionview/lib/action_view/helpers/number_helper.rb b/actionview/lib/action_view/helpers/number_helper.rb
@@ -26,6 +26,8 @@ def initialize(number)
 
       # Delegates to ActiveSupport::NumberHelper#number_to_phone.
       #
+      #   number_to_phone("1234567890")         # => "123-456-7890"
+      #
       # Additionally, supports a +:raise+ option that will cause
       # InvalidNumberError to be raised if +number+ is not a valid number:
       #
@@ -42,6 +44,8 @@ def number_to_phone(number, options = {})
 
       # Delegates to ActiveSupport::NumberHelper#number_to_currency.
       #
+      #   number_to_currency("1234")               # => "$1234.00"
+      #
       # Additionally, supports a +:raise+ option that will cause
       # InvalidNumberError to be raised if +number+ is not a valid number:
       #
@@ -54,6 +58,8 @@ def number_to_currency(number, options = {})
 
       # Delegates to ActiveSupport::NumberHelper#number_to_percentage.
       #
+      #   number_to_percentage("99")               # => "99.000%"
+      #
       # Additionally, supports a +:raise+ option that will cause
       # InvalidNumberError to be raised if +number+ is not a valid number:
       #
@@ -66,6 +72,8 @@ def number_to_percentage(number, options = {})
 
       # Delegates to ActiveSupport::NumberHelper#number_to_delimited.
       #
+      #   number_with_delimiter("1234")               # => "1,234"
+      #
       # Additionally, supports a +:raise+ option that will cause
       # InvalidNumberError to be raised if +number+ is not a valid number:
       #
@@ -78,6 +86,8 @@ def number_with_delimiter(number, options = {})
 
       # Delegates to ActiveSupport::NumberHelper#number_to_rounded.
       #
+      #   number_with_precision("1234")               # => "1234.000"
+      #
       # Additionally, supports a +:raise+ option that will cause
       # InvalidNumberError to be raised if +number+ is not a valid number:
       #
@@ -90,6 +100,8 @@ def number_with_precision(number, options = {})
 
       # Delegates to ActiveSupport::NumberHelper#number_to_human_size.
       #
+      #   number_to_human_size("1234")               # => "1.21 KB"
+      #
       # Additionally, supports a +:raise+ option that will cause
       # InvalidNumberError to be raised if +number+ is not a valid number:
       #
@@ -102,6 +114,8 @@ def number_to_human_size(number, options = {})
 
       # Delegates to ActiveSupport::NumberHelper#number_to_human.
       #
+      #   number_to_human("1234")               # => "1.23 Thousand"
+      #
       # Additionally, supports a +:raise+ option that will cause
       # InvalidNumberError to be raised if +number+ is not a valid number:
       #

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,8 @@ def initialize(number)`
`26`	`26`
`27`	`27`	`# Delegates to ActiveSupport::NumberHelper#number_to_phone.`
`28`	`28`	`#`
	`29`	`+ # number_to_phone("1234567890") # => "123-456-7890"`
	`30`	`+ #`
`29`	`31`	`# Additionally, supports a +:raise+ option that will cause`
`30`	`32`	`# InvalidNumberError to be raised if +number+ is not a valid number:`
`31`	`33`	`#`
`@@ -42,6 +44,8 @@ def number_to_phone(number, options = {})`
`42`	`44`
`43`	`45`	`# Delegates to ActiveSupport::NumberHelper#number_to_currency.`
`44`	`46`	`#`
	`47`	`+ # number_to_currency("1234") # => "$1234.00"`
	`48`	`+ #`
`45`	`49`	`# Additionally, supports a +:raise+ option that will cause`
`46`	`50`	`# InvalidNumberError to be raised if +number+ is not a valid number:`
`47`	`51`	`#`
`@@ -54,6 +58,8 @@ def number_to_currency(number, options = {})`
`54`	`58`
`55`	`59`	`# Delegates to ActiveSupport::NumberHelper#number_to_percentage.`
`56`	`60`	`#`
	`61`	`+ # number_to_percentage("99") # => "99.000%"`
	`62`	`+ #`
`57`	`63`	`# Additionally, supports a +:raise+ option that will cause`
`58`	`64`	`# InvalidNumberError to be raised if +number+ is not a valid number:`
`59`	`65`	`#`
`@@ -66,6 +72,8 @@ def number_to_percentage(number, options = {})`
`66`	`72`
`67`	`73`	`# Delegates to ActiveSupport::NumberHelper#number_to_delimited.`
`68`	`74`	`#`
	`75`	`+ # number_with_delimiter("1234") # => "1,234"`
	`76`	`+ #`
`69`	`77`	`# Additionally, supports a +:raise+ option that will cause`
`70`	`78`	`# InvalidNumberError to be raised if +number+ is not a valid number:`
`71`	`79`	`#`
`@@ -78,6 +86,8 @@ def number_with_delimiter(number, options = {})`
`78`	`86`
`79`	`87`	`# Delegates to ActiveSupport::NumberHelper#number_to_rounded.`
`80`	`88`	`#`
	`89`	`+ # number_with_precision("1234") # => "1234.000"`
	`90`	`+ #`
`81`	`91`	`# Additionally, supports a +:raise+ option that will cause`
`82`	`92`	`# InvalidNumberError to be raised if +number+ is not a valid number:`
`83`	`93`	`#`
`@@ -90,6 +100,8 @@ def number_with_precision(number, options = {})`
`90`	`100`
`91`	`101`	`# Delegates to ActiveSupport::NumberHelper#number_to_human_size.`
`92`	`102`	`#`
	`103`	`+ # number_to_human_size("1234") # => "1.21 KB"`
	`104`	`+ #`
`93`	`105`	`# Additionally, supports a +:raise+ option that will cause`
`94`	`106`	`# InvalidNumberError to be raised if +number+ is not a valid number:`
`95`	`107`	`#`
`@@ -102,6 +114,8 @@ def number_to_human_size(number, options = {})`
`102`	`114`
`103`	`115`	`# Delegates to ActiveSupport::NumberHelper#number_to_human.`
`104`	`116`	`#`
	`117`	`+ # number_to_human("1234") # => "1.23 Thousand"`
	`118`	`+ #`
`105`	`119`	`# Additionally, supports a +:raise+ option that will cause`
`106`	`120`	`# InvalidNumberError to be raised if +number+ is not a valid number:`
`107`	`121`	`#`