Improve Rails console helper methods' descriptions #51731
+18
−28
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
st0012
force-pushed
the
improve-rails-helpers-descriptions
branch
3 times, most recently
from
0de33de
to
2b7edf3
Compare
|
I'm keeping 2 commits separated because one drops a helper. |
|
@rafaelfranca I'd appreciate your input on this one 🙏 |
After rails#44748, the `new_session` helper no longer takes a block and is the same as calling `app(true)`. Therefore, I think there's no reason to expose it to Rails console users.
st0012
force-pushed
the
improve-rails-helpers-descriptions
branch
from
2b7edf3
to
9bf8208
Compare
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
When demonstrating the result of #51705, I received some feedback around the description of the new helpers.
Detail
new_sessionhas stopped taking block argument after Removed unwanted code which sets session host in console mode #44748, which nobody seems to discover and it's perhaps never used. And after that update,new_sessionis the same asapp(true), which makes me think it has become obsolete.Result
(In the next IRB patch release, I'll also make
confhelper's description clearer.)Additional information
Checklist
Before submitting the PR make sure the following are checked:
[Fix #issue-number]