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

Updates incorrect documentation [ci skip] #28444

Merged
merged 1 commit into from
Mar 17, 2017
Merged

Conversation

budnik
Copy link
Contributor

@budnik budnik commented Mar 16, 2017

Summary

Looking on code for this method it's clear that it's just return response.status instead of full response object. I wish it would work as documented but it's better to correct docs as probably lots of tests are relying on current behavior.

Other Information

It's easy to check what is actually returned:
_357

@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 @sgrif (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.

# called from an ActionDispatch::IntegrationTest object, then that
# object's <tt>@response</tt> instance variable will point to the same
# response object.
# object's <tt>@response</tt> instance variable will point to response object
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Response object

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch, @vipulnsward. I didn't saw that this typo was present. Updated with PR.

Looking on code for this method it's clear that it's just returns `response.status` instead of full `response` object.
It's better to correct docs as probably lots of specs are relying on this behavior.
@budnik budnik force-pushed the patch-2 branch 2 times, most recently from 6ce1c6c to 20a0f5e Compare March 16, 2017 11:32
@vipulnsward vipulnsward merged commit 7f6b072 into rails:master Mar 17, 2017
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