Don't auto-link to non-text source files in cross-references - #1646
Merged
Conversation
Collaborator
|
🚀 Preview deployment available at: https://522b1de1.rdoc-6cd.pages.dev (commit: f0bb055) |
st0012
force-pushed
the
autoresearch/fix-broken-c-file-links-2026-03-14
branch
from
March 14, 2026 23:11
3ac13a2 to
7fa27e3
Compare
st0012
force-pushed
the
autoresearch/fix-broken-c-file-links-2026-03-14
branch
from
March 14, 2026 23:14
7fa27e3 to
0bfce0d
Compare
RDoc's cross-reference system auto-links filenames like `array.c` when encountered in documentation text. However, non-text source files are not meant to have their own documentation pages, so these auto-generated links are always broken. Only suppress auto-linking. Explicit `rdoc-ref:` links to non-text files (enabled by #1376) continue to work.
st0012
force-pushed
the
autoresearch/fix-broken-c-file-links-2026-03-14
branch
from
March 14, 2026 23:16
0bfce0d to
f0bb055
Compare
st0012
marked this pull request as ready for review
March 14, 2026 23:16
tompng
approved these changes
Mar 21, 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
3 participants
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
array.cwhen encountered in documentation text, but non-text source files are not meant to have their own documentation pages, so these links are always broken (e.g. https://docs.ruby-lang.org/en/master/extension_rdoc.html#class-library)ToHtmlCrossref#link. Explicitrdoc-ref:links to non-text files (enabled by Allow rdoc-ref to link to non-text files #1376) continue to work