Fix RDoc links in Rake Information section #627
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
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.
Summary
This PR fixes the broken links in the Rake Information section of the documentation. Changed the link format from
link:doc/...tordoc-ref:doc/...so that RDoc properly resolves these links when generating HTML documentation.Fix: #538
Problem
When the RDoc documentation is generated, the four links in the Rake Information section do not work properly. This is because the links are using the
link:format which does not correctly translate to HTML hyperlinks during the documentation generation process.Solution
Modified the link format in README.rdoc from
link:doc/...tordoc-ref:doc/.... This change ensures that RDoc correctly processes these references when generating HTML documentation.Affected files
Testing
After making the changes, I regenerated the documentation using
bundle exec rake rdocand verified that all four links in the Rake Information section now function correctly.