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

Update example in Http::Headers object to use .from_hash #26144

Merged
merged 1 commit into from
Aug 12, 2016

Conversation

javierjulio
Copy link
Contributor

Summary

The documented example at the top of ActionDispatch::Http::Headers definition provided a hash for the constructor but in Rails 5 this has changed to now take a request object. An earlier commit introduced a ActionDispatch::Http::Headers.from_hash() method that the example should now be using.

Other Information

When initializing an ActionDispatch::Http::Headers object it takes a request object (Rails 5) whereas before it took a hash (Rails 4.x) but the documented example still shows a hash given to the constructor (due to commit 34fa665 by @tenderlove) so this is just a documentation change to use the new from_hash method introduced in that earlier commit.

This is my first PR (I've reported an issue or two before) so I might have the process wrong. Sorry, I was confused with the guidelines on doc changes since this is for the documented example in the code file rather than pages in the guides. I take it its done in the right place. If not let me know what I have to do and be happy to update. Thanks.

When initializing an `ActionDispatch::Http::Headers` object it takes a request object (Rails 5) whereas before it took a hash (Rails 4.x) but the documented example still shows a hash given to the constructor (due to commit 34fa665) so this is just a documentation change to use the new `from_hash` method introduced in that earlier commit.
@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 @schneems (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.

@maclover7
Copy link
Contributor

Great first PR @javierjulio!! This looks good to me, but in the future, please add [ci skip] to the body of your Git commit to avoid running Travis CI for documentation changes.

❤️ 💚 💙 💛 💜

@maclover7 maclover7 merged commit 3c8e9e8 into rails:master Aug 12, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants