Repository navigation
Conversation
Member
|
I think the paragraph in the RDoc link docs is poorly worded as Switching to |
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.
You will know your audience better than me, but the links in the README that use
rdoc-refto markup the links do not work in Github. If you expect most people to view the README through an RDoc generator/viewer of some sort than the current optimization for RDoc is likely preferable. If the Github use-case is valid one, then consider this PR.This PR switches those links to use
linkto markup the links instead.According to the RDoc link docs:
Again, you will probably know better than I would if there is likely to be variation in the target of those links across different RDoc generators. I'm skeptical, but I know relatively little about RDoc.
Since using
rdoc-refseems pretty reasonable, I've also opened an issue with Github.