Fix broken documentation links in Net::HTTP#304
Merged
Conversation
RDoc parsed ENV['http_proxy'] inside the link label as a cross-reference,
emitting a stray <a href="'http_proxy'">ENV</a> and breaking the
surrounding {label}[url] markup. Drop the subscript from the label.
#292
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
Several attribute docs used {label}[url] markup whose URL pointed at targets like OpenSSL::SSL::SSL::Context#ciphers=. RDoc emitted those verbatim as relative hrefs that never resolved, so the links rendered broken on the master documentation. They now point at the full OpenSSL::SSL::SSLContext documentation URLs.
The proxy_from_env= link failed for a different reason. RDoc parsed ENV['http_proxy'] inside the link label as a cross-reference and produced a stray ENV link while breaking the surrounding markup. Dropping the subscript from the label resolves it.
Fixes #288
Fixes #289
Fixes #290
Fixes #291
Fixes #292
Fixes #293
Fixes #294