diff options
author | James Lovejoy <james@sparkart.com> | 2018-01-19 17:56:00 -0800 |
---|---|---|
committer | James Lovejoy <james@sparkart.com> | 2018-01-19 17:56:00 -0800 |
commit | 403d0d8f9e69029dcfe5313d07dff7705141849e (patch) | |
tree | e76e98956fe1586e14b854b4b97a5d11b8b3396a /actionview | |
parent | 9b0c74e8780f9769320ee912e43066627602ce68 (diff) | |
download | rails-403d0d8f9e69029dcfe5313d07dff7705141849e.tar.gz rails-403d0d8f9e69029dcfe5313d07dff7705141849e.tar.bz2 rails-403d0d8f9e69029dcfe5313d07dff7705141849e.zip |
Fix typos. Improve text_helper documentation.
[ci skip]
Diffstat (limited to 'actionview')
-rw-r--r-- | actionview/lib/action_view/helpers/text_helper.rb | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/actionview/lib/action_view/helpers/text_helper.rb b/actionview/lib/action_view/helpers/text_helper.rb index 84d38aa416..34138de00e 100644 --- a/actionview/lib/action_view/helpers/text_helper.rb +++ b/actionview/lib/action_view/helpers/text_helper.rb @@ -13,9 +13,9 @@ module ActionView # # ==== Sanitization # - # Most text helpers by default sanitize the given content, but do not escape it. - # This means HTML tags will appear in the page but all malicious code will be removed. - # Let's look at some examples using the +simple_format+ method: + # Most text helpers that generate HTML output sanitize the given input by default, + # but do not escape it. This means HTML tags will appear in the page but all malicious + # code will be removed. Let's look at some examples using the +simple_format+ method: # # simple_format('<a href="http://example.com/">Example</a>') # # => "<p><a href=\"http://example.com/\">Example</a></p>" @@ -128,7 +128,7 @@ module ActionView # # => You searched for: <a href="search?q=rails">rails</a> # # highlight('<a href="javascript:alert(\'no!\')">ruby</a> on rails', 'rails', sanitize: false) - # # => "<a>ruby</a> on <mark>rails</mark>" + # # => <a href="javascript:alert('no!')">ruby</a> on <mark>rails</mark> def highlight(text, phrases, options = {}) text = sanitize(text) if options.fetch(:sanitize, true) |