[DOC] Fix broken rdoc-ref links #199
Merged
Conversation
This file contains 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
Those alias methods have been marked as `:nodoc: obsolete` for a long time. Which means the `rdoc-ref` links to them will be broken. Unless we want to encourage users to use them again, we don't need to mention them in the documentation.
Since `net-http` doesn't have its own documentation site and is always included in the Ruby documentation, we should use the proper `rdoc-ref` to link to `OpenSSL::SSL::SSLContext` methods, not linking to `docs.ruby-lang.org`.
jeremyevans
approved these changes
Dec 16, 2024
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.
Found through ruby/rdoc#1241
There are 2 changes:
aliased asdescription are not linking properly because those alias methods have been marked as:nodoc: obsoletefor a long time, which breaks therdoc-reflinks. Unless we want to encourage users to use them again, we don't need to mention them in the documentation.OpenSSL::SSL::SSLContextmethods using the properrdoc-refinstead of linking todocs.ruby-lang.orgto make sure their linked properly after synced toruby/ruby.