aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport
diff options
context:
space:
mode:
authorEileen M. Uchitelle <eileencodes@users.noreply.github.com>2017-11-04 09:32:24 -0400
committerGitHub <noreply@github.com>2017-11-04 09:32:24 -0400
commit300dd48df85d9a65a51dddb692b647fc1d8d1588 (patch)
treef99d768ea303a26645bffe908954279a099dcb80 /activesupport
parent85cda0f6f349744b6f1452d5f1f6cf74ef694393 (diff)
parent23d5d5830690a8d22f0fe3762a8399a1f8a6d069 (diff)
downloadrails-300dd48df85d9a65a51dddb692b647fc1d8d1588.tar.gz
rails-300dd48df85d9a65a51dddb692b647fc1d8d1588.tar.bz2
rails-300dd48df85d9a65a51dddb692b647fc1d8d1588.zip
Merge pull request #31014 from aditya-kapoor/doc-fixes
[ci skip] show the correct example to demonstrate inflections.
Diffstat (limited to 'activesupport')
-rw-r--r--activesupport/lib/active_support/inflector/transliterate.rb8
1 files changed, 7 insertions, 1 deletions
diff --git a/activesupport/lib/active_support/inflector/transliterate.rb b/activesupport/lib/active_support/inflector/transliterate.rb
index 9801f1d118..e689f0718e 100644
--- a/activesupport/lib/active_support/inflector/transliterate.rb
+++ b/activesupport/lib/active_support/inflector/transliterate.rb
@@ -76,13 +76,19 @@ module ActiveSupport
# To use a custom separator, override the `separator` argument.
#
# parameterize("Donald E. Knuth", separator: '_') # => "donald_e_knuth"
- # parameterize("^trés|Jolie-- ", separator: '_') # => "tres_jolie"
+ # parameterize("^trés|Jolie__ ", separator: '_') # => "tres_jolie"
#
# To preserve the case of the characters in a string, use the `preserve_case` argument.
#
# parameterize("Donald E. Knuth", preserve_case: true) # => "Donald-E-Knuth"
# parameterize("^trés|Jolie-- ", preserve_case: true) # => "tres-Jolie"
#
+ # It preserves dashes and underscores unless they are used as separators:
+ #
+ # parameterize("^trés|Jolie__ ") # => "tres-jolie__"
+ # parameterize("^trés|Jolie-- ", separator: "_") # => "tres_jolie--"
+ # parameterize("^trés_Jolie-- ", separator: ".") # => "tres_jolie--"
+ #
def parameterize(string, separator: "-", preserve_case: false)
# Replace accented chars with their ASCII equivalents.
parameterized_string = transliterate(string)