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.

Sign up for GitHub

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

Jump to bottom

Repurpose help command to show help messages #787

Closed
st0012 opened this issue Nov 25, 2023 · 1 comment · Fixed by #872
Closed

Repurpose help command to show help messages #787

st0012 opened this issue Nov 25, 2023 · 1 comment · Fixed by #872
Labels
enhancement New feature or request

Comments

@st0012
Copy link
Member

st0012 commented Nov 25, 2023 •
edited
Loading

We have been printing the deprecation message for help for a while:

[Deprecation] The `help` command will be repurposed to display command help in the future.
For RI document lookup, please use the `show_doc` command instead.
For command help, please use `show_cmds` for now.

For users installing IRB as a gem, they should have been exposed to the warning for a while. However, for users using the bundled IRB, they likely haven't seen it yet.

As a result, we should at least wait for Ruby 3.3 is released to make this change.

Addresses one of the points in #775
@st0012 st0012 added the enhancement New feature or request label Nov 25, 2023
@nunosilva800
Copy link
Contributor

Agreed. I think we can now repurpose help to do what people expect it to do. show_cmds is just not intuitive.

st0012 added a commit that referenced this issue Feb 13, 2024
@st0012
Repurpose the help command to display the help message
dc300bf 
See #787 for more details.
@st0012 st0012 mentioned this issue Feb 13, 2024
Merged
tompng pushed a commit that referenced this issue Feb 14, 2024
@st0012
Repurpose the help command to display the help message (#872)
d9192d9 
See #787 for more details.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Repurpose the help command to display the help message ruby/irb
2 participants
@nunosilva800 @st0012