Repository navigation
Support RDoc 8 formatter initialization - #2109
Merged
Merged
Conversation
Preserve positional options for RDoc 4–7 and use the keyword-based formatter defaults for RDoc 8. Add regression coverage and test RDoc 7.2 and 8.x in CI. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 04620c2c-d05c-4684-9275-33956737b425
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 93ffdf64-9ffd-47b4-b3d4-96dda4ae722d
joelhawksley
force-pushed
the
joelhawksley-rdoc-8-compatibility
branch
from
October 15, 2026 18:05
ab78de4 to
30f50d6
Compare
joelhawksley
commented
Oct 15, 2026
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 93ffdf64-9ffd-47b4-b3d4-96dda4ae722d
joelhawksley
commented
Oct 15, 2026
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 93ffdf64-9ffd-47b4-b3d4-96dda4ae722d
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 93ffdf64-9ffd-47b4-b3d4-96dda4ae722d
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 93ffdf64-9ffd-47b4-b3d4-96dda4ae722d
There was a problem hiding this comment.
🔵 Needs a closer look
The broader runtime dependency range and renamed CI checks warrant maintainer confirmation.
0 open findings
What changed in this PR
Adds RDoc 8 rendering support while preserving initialization behavior for earlier versions.
Changes:
- Selects the formatter constructor by RDoc version and permits RDoc versions below 9.
- Adds RDoc 8 CI coverage while retaining the default RDoc 7.2 lockfile.
- Updates installation and testing documentation.
| File | Description |
|---|---|
| test/coverage_test.rb | Removes an outdated legacy-branch comment. |
| README.md | Removes the obsolete RDoc installation pin. |
| lib/github/markup/rdoc.rb | Selects version-compatible formatter initialization. |
| github-markup.gemspec | Allows RDoc 8 as a runtime dependency. |
| Gemfile.lock | Updates the dependency bound while retaining RDoc 7.2. |
| Gemfile | Makes the development RDoc requirement configurable. |
| CONTRIBUTING.md | Documents local RDoc 8 testing. |
| .github/workflows/ci.yml | Adds RDoc 8 testing on Ruby 4.0. |
🧠 Review effort: Max
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
zkoppert
approved these changes
Oct 15, 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.
Summary
RDoc 8 changed
RDoc::Markup::ToHtmlto accept keyword options, so passing a positionalRDoc::OptionsraisesArgumentError.:nocov:since each run covers only the installed RDoc. The existingtest_rdocfixture test fails on RDoc 8 without this fix, and CI now runs it against RDoc 8.rdoc < 8tordoc < 9.Validation
After rebasing on master, re-ran
bundle exec rakeon Ruby 3.4.10 against RDoc 7.2.0 and 8.1.0: 62 runs, 0 failures, 100% line/branch coverage.