Skip to content

Use link markup instead of rdoc-ref for URLs in README - #6

Closed
tdg5 wants to merge 1 commit into
ruby:masterfrom
tdg5:README_link_fix
Closed

tdg5 wants to merge 1 commit into
ruby:masterfrom
tdg5:README_link_fix

Conversation

@tdg5

@tdg5 tdg5 commented Nov 28, 2014

Copy link
Copy Markdown

You will know your audience better than me, but the links in the README that use rdoc-ref to 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 link to markup the links instead.

According to the RDoc link docs:

Use rdoc-ref: instead of link: to link to files generated by RDoc as the link target may be different across RDoc generators.

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-ref seems pretty reasonable, I've also opened an issue with Github.

@drbrain

drbrain commented Dec 3, 2014

Copy link
Copy Markdown
Member

I think the paragraph in the RDoc link docs is poorly worded as rdoc-ref: is preferred over link:.

Switching to link: breaks the links so I must reject this pull request. You can test with rake docs then loading html/index.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants