Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Links to document texts without "rdoc-ref:" prefix #800

Merged
merged 2 commits into from Mar 30, 2021

Conversation

nobu
Copy link
Member

@nobu nobu commented Mar 21, 2021

While links to generated HTML from RDoc file needs to be prefixed by "rdoc-ref:" currently, in case of explicit references this seems just redundant.

Also GitHub RDoc support does not work with this prefix.

This patch lets links to such document texts (".rb", ".rdoc" and ".md" now) refer URLs generated by RDoc::TopLevel#http_url without the prefix.

The dots in all path components from the document root are
replaced with underscores, not only in the basename.
While links to generated HTML from RDoc file needs to be prefixed
by "rdoc-ref:" currently, in case of explicit references this
seems just redundant.

Also GitHub RDoc support does not work with this prefix.

This patch lets links to such document texts (".rb", ".rdoc" and
".md" now) refer URLs generated by `RDoc::TopLevel#http_url`
without the prefix.
@aycabta aycabta merged commit 2810ec5 into ruby:master Mar 30, 2021
@nobu nobu deleted the rdoc-links branch April 5, 2021 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants