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

Rename IDB::ReidlineInputMethod to IRB::RelineInputMethod #409

Merged
merged 1 commit into from
Oct 5, 2022

Conversation

gmcgibbon
Copy link
Contributor

Deprecates IDB::ReidlineInputMethod and USE_REIDLINE in favor of IRB::RelineInputMethod and USE_RELINE. The Input method uses Reline to read input from the console, so it can be named directly after the Reline library like other inputs methods are (Readline, Stdio, etc.).

Deprecates IDB::ReidlineInputMethod and USE_REIDLINE in favor of
IRB::RelineInputMethod and USE_RELINE. The Input method uses Reline to
read input from the console, so it can be named directly after the
Reline library like other inputs methods are (Readline, Stdio, etc.).
@hsbt hsbt merged commit 5bcade7 into ruby:master Oct 5, 2022
@hsbt
Copy link
Member

hsbt commented Oct 5, 2022

Nice catch, Thanks!

warn <<~MSG.strip
USE_REIDLINE is deprecated, please use USE_RELINE instead.
MSG
@use_multiline = IRB.conf[:USE_RELINE]
Copy link
Member

Choose a reason for hiding this comment

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

If this is for backward compatibility, shouldn't this be USE_REIDLINE?

Copy link
Member

Choose a reason for hiding this comment

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

maked sense.

@st0012
Copy link
Member

st0012 commented Oct 5, 2022

@gmcgibbon Thanks for the PR. But even though most users don't use it directly, gems and apps may reference the ReidlineInputMethod directly (example). This change also means apps that use Sorbet will fail type checking after upgrading irb because the names will mismatch in their rbi files.

Given the above reasons, I actually planned to put it on hold and split the changes in different levels of releases.

@hsbt Can we:

  1. Revert this change
  2. Add the deprecation message for USE_REIDLINE config option
  3. Cut v1.4.3 for the above changes

I can make PRs for them if you think the approach is reasonable.

@hsbt
Copy link
Member

hsbt commented Oct 5, 2022

I understood your suggestion. But I won't care about sorbet use-case because I'm not sorbet user.

@@ -470,4 +470,13 @@ def inspect
str
end
end

class ReidlineInputMethod < RelineInputMethod
Copy link
Member

Choose a reason for hiding this comment

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

Sorry that I missed this definition. I think it's a safe change and added #411 to pick up a few leftovers.

@gmcgibbon gmcgibbon deleted the rename_reidline_to_reline branch February 27, 2024 23:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants