Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos and improve text_helper documentation regarding sanitization #31749

Merged
merged 1 commit into from
Jan 20, 2018

Conversation

jameslovejoy
Copy link
Contributor

Summary

  • Fixes doc typos in actionpack/lib/action_dispatch/routing/mapper.rb
  • Fixes an example given for the highlight helper with sanitize: false
  • Improves the introductory paragraph about sanitization in 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 the highlight 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.

@rails-bot
Copy link

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @pixeltrix (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.

Please see the contribution instructions for more information.

@kamipo kamipo merged commit 05baed0 into rails:master Jan 20, 2018
@jameslovejoy jameslovejoy deleted the fix-documentation branch January 20, 2018 18:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants