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

Encourage html-safe API in layouts/rendering guide #30734

Merged
merged 1 commit into from
Oct 4, 2017
Merged

Encourage html-safe API in layouts/rendering guide #30734

merged 1 commit into from
Oct 4, 2017

Conversation

oreoshake
Copy link
Contributor

This is a second pass at #30576 /cc @georgeclaghorn

Summary

While the code example was not unsafe, it encourages the use of confusingly unsafe APIs
(specifically html_safe). We have a safe alternative and we should encourage people to use
it.

I don't know if there is an open issue for this, but a quick search doesn't reveal one.

Other Information

Finally, if your pull request affects documentation or any non-code
changes, guidelines for those changes are available
here

I've added:

composed with html_safe-aware APIs`

I'm not sure if the language is OK or whether or not it should link to https://github.com/rails/rails/blob/b9ecb5797b97ba557a70efd66d2ff2c22501723f/guides/source/active_support_core_extensions.md#output-safety for more details.

While the code example was not unsafe, it
encourages the use of confusingly unsafe APIs
(specifically `html_safe`). We have a safe
alternative and we should encourage people to use
it under all circumstances.
@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 @rafaelfranca (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.

@eileencodes eileencodes merged commit df28146 into rails:master Oct 4, 2017
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