Fix broken legacy rdoc-ref labels and duplicate heading IDs #1602
+150
−8
Conversation
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
Collaborator
|
🚀 Preview deployment available at: https://f19c52b3.rdoc-6cd.pages.dev (commit: 9aa01f2) |
tompng
reviewed
Feb 8, 2026
test/rdoc/markup/to_label_test.rb
Outdated
|
|
||
| def test_decode_legacy_label_alphanumeric_hex_unchanged | ||
| # -4F decodes to 'O' (alphanumeric), so leave as literal | ||
| assert_equal "class-4Fther", RDoc::Text.decode_legacy_label("class-4Fther") |
Member
There was a problem hiding this comment.
I think adding test case of something like "class-Feather" not to be converted to "class\xFEather" may help prevent regression.
This will detect a bug changing /-([0-9A-F]{2})/ to /-([0-9A-Fa-f]{2})/ in the future
tompng
approved these changes
Feb 8, 2026
tompng
reviewed
Feb 8, 2026
lib/rdoc/text.rb
Outdated
|
|
||
| module_function def decode_legacy_label(label) | ||
| label = label.tr('+', ' ') | ||
| label.gsub!(/-([0-9A-F]{2})/) do |
Member
There was a problem hiding this comment.
If it's OK to assume encoded parts to be ascii, /-([0-7][0-9A-F])/ might be better
Decode legacy CGI-encoded labels (e.g., `What-27s+Here`) in rdoc-ref links so they resolve to the correct GitHub-style anchors. Also deduplicate heading IDs by appending -1, -2, etc. when multiple headings produce the same anchor (e.g., "Method match" and "Method match?" both becoming `method-match`). Fixes #1590
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.
Decode legacy CGI-encoded labels (e.g.,
What-27s+Here) in rdoc-ref links so they resolve to the correct GitHub-style anchors. Also deduplicate heading IDs by appending -1, -2, etc. when multiple headings produce the same anchor (e.g., "Method match" and "Method match?" both becomingmethod-match).Fixes #1590