diff options
| author | Ryuta Kamizono <kamipo@gmail.com> | 2018-01-20 12:58:03 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-01-20 12:58:03 +0900 |
| commit | 05baed07caaa54a77d144779641951135e6b2650 (patch) | |
| tree | e76e98956fe1586e14b854b4b97a5d11b8b3396a | |
| parent | 9b0c74e8780f9769320ee912e43066627602ce68 (diff) | |
| parent | 403d0d8f9e69029dcfe5313d07dff7705141849e (diff) | |
| download | rails-05baed07caaa54a77d144779641951135e6b2650.tar.gz rails-05baed07caaa54a77d144779641951135e6b2650.tar.bz2 rails-05baed07caaa54a77d144779641951135e6b2650.zip | |
Merge pull request #31749 from jameslovejoy/fix-documentation
Fix typos and improve text_helper documentation regarding sanitization
[ci skip]
| -rw-r--r-- | actionpack/lib/action_dispatch/routing/mapper.rb | 6 | ||||
| -rw-r--r-- | actionview/lib/action_view/helpers/text_helper.rb | 8 |
2 files changed, 7 insertions, 7 deletions
diff --git a/actionpack/lib/action_dispatch/routing/mapper.rb b/actionpack/lib/action_dispatch/routing/mapper.rb index d87a23a58c..31eb6104fe 100644 --- a/actionpack/lib/action_dispatch/routing/mapper.rb +++ b/actionpack/lib/action_dispatch/routing/mapper.rb @@ -1573,7 +1573,7 @@ module ActionDispatch # Matches a URL pattern to one or more routes. # For more information, see match[rdoc-ref:Base#match]. # - # match 'path' => 'controller#action', via: patch + # match 'path' => 'controller#action', via: :patch # match 'path', to: 'controller#action', via: :post # match 'path', 'otherpath', on: :member, via: :get def match(path, *rest, &block) @@ -2082,9 +2082,9 @@ module ActionDispatch # [ :products, options.merge(params.permit(:page, :size).to_h.symbolize_keys) ] # end # - # In this instance the +params+ object comes from the context in which the the + # In this instance the +params+ object comes from the context in which the # block is executed, e.g. generating a URL inside a controller action or a view. - # If the block is executed where there isn't a params object such as this: + # If the block is executed where there isn't a +params+ object such as this: # # Rails.application.routes.url_helpers.browse_path # 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) |