Encapsulate superclass method link rendering#1741
Merged
st0012 merged 1 commit intoJun 23, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors how the HTML generators render the “Calls superclass method …” link by moving link construction into a generator-facing helper on RDoc::AnyMethod, making escaping behavior explicit and keeping formatter details out of templates.
Changes:
- Add
RDoc::AnyMethod#superclass_method_linkto encapsulate superclass-method link rendering (including escaping of visible text). - Update Aliki and Darkfish class templates to call
superclass_method_linkinstead of reaching intomethod.formatter. - Add generator markup tests covering normal and operator (
<<) method names.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| test/rdoc/generator/markup_test.rb | Adds unit tests for superclass_method_link, including operator-name escaping. |
| lib/rdoc/generator/template/darkfish/class.rhtml | Switches superclass-method notice rendering to the new helper. |
| lib/rdoc/generator/template/aliki/class.rhtml | Switches superclass-method notice rendering to the new helper. |
| lib/rdoc/generator/markup.rb | Introduces RDoc::AnyMethod#superclass_method_link for generator use. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
tompng
approved these changes
Jun 23, 2026
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
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.
Problem
While reviewing #1571, I noticed a small follow-up refactoring opportunity in the superclass-method notice rendered by the HTML templates.
Both Aliki and Darkfish were reaching through
method.formatterdirectly to build the superclass method link. That leaves template code responsible for formatter details and makes the escaping boundary less explicit.Solution
RDoc::AnyMethod#superclass_method_linkas the generator-facing helper for rendering the superclass method link.<<.