Fix the broken "Show source" toggle for Ruby 3.4 docs #2466
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
… link when generated from Ruby 3.4+
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.
Should fix #2417.
With Ruby 3.4 the documentation is generated using a different theme, which impacted the layout of the page and the classes for HTML elements. Without the change the "Source" toggle from the original doc is copied over into the the final document without doing anything, whereas the expected header "Show source" link is missing and as the result the source code cannot be viewed.
This PR updates
Docs::Rdoc::CleanHtmlFilterto add a link for methods with the source and remove the superfluous "Source" toggle from the original documentation.Manually tested on documentation from Ruby 3.3 and 3.4.
Before
After