Declare rdoc as dependency #648
Merged
Conversation
This file contains 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
IRB already has several features that rely on rdoc, such as: - Autocompletion's document dialog - Autocompletion's `PerfectMatchedProc` - The `show_doc` command - Easter egg And we could use its pager more in the future too. So it makes sense to declare rdoc as a dependency instead of relying on the one bundled with Ruby.
tompng
approved these changes
Jul 18, 2023
matzbot
pushed a commit
to ruby/ruby
that referenced
this pull request
Jul 18, 2023
(ruby/irb#648) IRB already has several features that rely on rdoc, such as: - Autocompletion's document dialog - Autocompletion's `PerfectMatchedProc` - The `show_doc` command - Easter egg And we could use its pager more in the future too. So it makes sense to declare rdoc as a dependency instead of relying on the one bundled with Ruby. ruby/irb@4dffbb1dd3
This was referenced Sep 4, 2023
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.
IRB already has several features that rely on rdoc, such as:
PerfectMatchedProcshow_doccommandAnd we could use its pager more in the future too. So it makes sense to declare rdoc as a dependency instead of relying on the one bundled with Ruby.
How will this affect Rails?
TL;DR -
rdocwill be installed as a gem in all environments, but won't be required outside ofrails consoleusages. In production,rdocwill only be required when IRB's document look-up commands are used because autocompletion is diabled.rdocas a gem along withirbirbin console_command.rb, which is not loaded unlessrails consoleis run. So whatever IRB requires, includingrdoc, won't be loaded outside ofrails console.rdoc. And consider Rails disables IRB's autocompletion in production,rdocwon't be loaded unlessshow_doc/helpcommands are run.