Fix typos and improve text_helper documentation regarding sanitization #31749
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
actionpack/lib/action_dispatch/routing/mapper.rb
highlight
helper withsanitize: false
text_helper.rb
Other Information
With
sanitize: false
, the helper leaves the input HTML alone, but the documentation was incorrectly showing it as sanitized for thehighlight
helper.The introductory sentence about sanitization said "Most text helpers by default sanitize the given content..." However, only 2 of the 11 helpers actually sanitize their given inputs, so I clarified it by adding "that generate HTML output" since that was the original reasoning when sanitization was added in 84d387b.
I'm open to any suggestions for clarifying the sanitization description further.