Add Darkfish deprecation warning - #1797
Open
st0012 wants to merge 1 commit into
Open
Conversation
Collaborator
|
🚀 Preview deployment available at: https://fdaa01e1.rdoc-6cd.pages.dev (commit: db5818b) |
Assisted-By: devx/0d67a386-6fea-4c9d-96ef-064c1cc8810c
st0012
force-pushed
the
codex/add-darkfish-deprecation-warning
branch
from
September 12, 2026 14:45
db5818b to
19eec2a
Compare
Documentation previewCommit: |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The exact-class guard prevents Darkfish subclasses from receiving the intended warning.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Adds runtime notice of Darkfish’s planned removal in RDoc 9.0 while keeping Aliki quiet.
Changes:
- Adds a Darkfish deprecation warning.
- Tests warning behavior for Darkfish and Aliki.
File summaries
| File | Description |
|---|---|
lib/rdoc/generator/darkfish.rb |
Emits the deprecation warning. |
test/rdoc/generator/darkfish_test.rb |
Tests Darkfish warning output. |
test/rdoc/generator/aliki_test.rb |
Verifies Aliki remains silent. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 1
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+217
to
+219
| if self.class == Generator::Darkfish | ||
| warn "The Darkfish template is deprecated and will be removed in version 9.0." | ||
| end |
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.
I want to remove Darkfish completely in the next major release, so let's start showing deprecation warnings for it.
We can't cover all the cases where Darkfish is used, so this is just a best effort notification. Readme has been announcing this removal for a while.