Document a full list of commands #451
Merged
Conversation
This file contains hidden or 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
reviewed
Nov 19, 2022
matzbot
pushed a commit
to ruby/ruby
that referenced
this pull request
Nov 19, 2022
(ruby/irb#451) * Document a full list of commands * Document debug as well * Make it less duplicated
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Partly address this problem #449 (comment):
With the current way of README format, I haven't noticed IRB had a long document at https://docs.ruby-lang.org/en/master/IRB.html until today. I find it more discoverable to just write them down in README like debug.gem https://github.com/ruby/debug#debug-command-on-the-debug-console.
So, while I added the list to the official documentation for its readers, I also added it to the README as well. This should be useful even after #450 since you'll somehow need to discover
helpcommand itself. Having that in README could be a good help.Note that this list is based on this comment. I think we could document this even better, e.g. have categories or show commonly-used commands first, but that shouldn't stop this PR from being merged. I'd like to focus on having something first, and then improve it in other PRs.