Support looking up global variables and predefined constants in ri #1477
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
Add the ability to look up documentation for global variables (e.g., $<, $LOAD_PATH) and predefined constants (e.g., STDIN, ARGV, RUBY_VERSION) directly through the ri command. Documentation is extracted from the globals.rdoc page in the system store. Changes: - Add display_global method to look up and display global documentation - Add extract_global_section to parse hierarchical headings in globals.rdoc - Add predefined_global_constant? to identify STDIN, ARGV, RUBY_* etc. - Update display_name to handle $-prefixed names and predefined constants - Update expand_name to skip expansion for globals - Fix nil matches bug in error handling when unknown globals are queried - Update help text with examples for global variable lookups
adam12
temporarily deployed
to
fork-preview-protection
GitHub Actions
Inactive
Contributor
Author
|
Parsing globals is less than ideal but I am not sure of a better approach. I'd love to see some support for keywords too but the same trick won't work (AFAICT). |
zenspider
approved these changes
Nov 27, 2025
Collaborator
|
🚀 Preview deployment available at: https://034ce9e8.rdoc-6cd.pages.dev (commit: 6c00877) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Add the ability to look up documentation for global variables (e.g., $<, $LOAD_PATH) and predefined constants (e.g., STDIN, ARGV, RUBY_VERSION) directly through the ri command. Documentation is extracted from the globals.rdoc page in the system store.
Changes: