Add link to Ruby options doc in help text #14142
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
Aug 7, 2025
|
Just confirmed that html comments work with RDoc: |
st0012
approved these changes
Aug 8, 2025
Adds link to https://docs.ruby-lang.org/en/master/ruby/options_md.html in Ruby help text (-h and --help).
❌ Tests Failed✖️no tests failed ✔️62183 tests passed(3 flakes) |
nobu
reviewed
Aug 8, 2025
Comment on lines
+408
to
+410
| printf("Details and examples at https://docs.ruby-lang.org/en/%s/ruby/options_md.html\n", | ||
| RUBY_PATCHLEVEL == -1 ? "master" : STRINGIZE(RUBY_VERSION_MAJOR) "." STRINGIZE(RUBY_VERSION_MINOR)); | ||
|
|
There was a problem hiding this comment.
Detailed info should be only when --help.
And keep revision info only in version.c.
There was a problem hiding this comment.
I'm not sure what you mean here.
Detailed info should be only when --help.
We're not showing any detailed info? Just linking to a web page that could explain and give examples about the options in -h and --help. I think it should be shown for both of these cases. Do you have other opinions?
And keep revision info only in version.c.
Do you mean the use of RUBY_PATCHLEVEL? How would we get the information about whether to use master or a version otherwise?
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.
Adds link to https://docs.ruby-lang.org/en/master/ruby/options_md.html in Ruby help text (-h and --help).