Disambiguate language around when controller code stops re: redirect_to [ci skip]
#51032
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This paragraph tends to cause confustion with Rails developers who have just learned the correct control flow of `redirect_to` and `render`. A phrase above it in the "Avoiding Double Render Errors" section clears up a common misunderstanding that `render` will stop execution within a controller action. That misunderstanding is further corrected with the following phrase. > But this will _not_ stop the rest of the code in the `show` action from running This section is often enough to get the point across for newer developers who might often be running into double render errors, but soon after the phrase which attempts the same illustration of `redirect_to`'s execution confuses the matter by using the same language as the earlier statement to mean the opposite. > Sometimes inexperienced developers think of `redirect_to` as a sort of `goto` command, moving execution from one place to another in your Rails code. This is _not_ correct. Your code stops running and waits for a new request from the browser. Here "Your code stops running" means that the action will run to completion and not jump to another site in controller code. This often re-confuses the concept they've just learned and undermines their understanding. By being more specific in the second phrase, we can reinforce the concept instead.
|
Thanks for the PR 🎉 |
skipkayhil
added a commit
that referenced
this pull request
Feb 9, 2024
…ils--redirect-to-disambiguation Disambiguate language around when controller code stops re: `redirect_to` [ci skip]
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation / Background / Description
Changes to: Layouts and Rendering: 2.3.2 The Difference Between render and redirect_to
The changed paragraph tends to cause confustion with Rails developers who have just learned the correct control flow of
redirect_toandrender.A phrase above it in the "Avoiding Double Render Errors" section clears up a common misunderstanding that
renderwill stop execution within a controller action. That misunderstanding is further clarified with a following phrase.This section is often enough to get the point across for newer developers who might often be running into double render errors, but soon after the phrase which attempts the same illustration of
redirect_to's execution confuses the matter by using the same language as the earlier statement to mean the opposite.Here "Your code stops running" means that the action will run to completion and not jump to another site in controller code, where the other phrase "stop the rest of the code ... from running" is used to illustrate the misunderstanding and means the action will not run to completion. This often re-confuses the concept they've just learned and undermines their understanding. By being more specific in the second phrase, we can reinforce the concept instead.
The change
Open to feedback around the particular phrasing or formatting, the important part is changing the re-use of the "stops ... running" terminology.
Checklist
Before submitting the PR make sure the following are checked:
[Fix #issue-number]