Enable cross reference in code #1240
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
st0012
requested changes
Dec 14, 2024
There was a problem hiding this comment.
I have a few questions/concerns:
- Given the place this changes are made, I think it'd be applied to markdown's too?
- Will these additional linking attempts cause significant slowdown when generating docs for large projects, like
ruby/ruby - We need to make sure when a code block doesn't link, it's still rendered as code block.
-
Currently, it breaks most of the inline code blocks in
MarkupReference.html
They should be:
-
lib/rdoc/markup/to_html_crossref.rb
Outdated
| case item | ||
| when RDoc::Markup::AttrChanger then | ||
| # Make "+Class#method+" a cross reference | ||
| if respond_to?(:cross_reference) and |
Yes, as mentioned in the description, the motivation is to mark up in markdown, but not only for it.
There was no significant difference, 27sec -> 27sec on my machine.
Fixed. |
st0012
reviewed
Dec 16, 2024
Some people like to mark up method names in MarkDown style block quotes, like this: ruby/ruby#12333. Currently, no links are created in the code in the RDoc, but such words most likely refer to methods. This PR makes a word a code cross-reference if the whole word can be resolved as a reference.
st0012
approved these changes
Dec 17, 2024
matzbot
pushed a commit
to ruby/ruby
that referenced
this pull request
Dec 17, 2024
(ruby/rdoc#1240) Some people like to mark up method names in MarkDown style block quotes, like this: #12333. Currently, no links are created in the code in the RDoc, but such words most likely refer to methods. This PR makes a word a code cross-reference if the whole word can be resolved as a reference. ruby/rdoc@7d7efb0709
nobu
added a commit
to nobu/rdoc
that referenced
this pull request
Dec 31, 2024
st0012
pushed a commit
that referenced
this pull request
Dec 31, 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.
Some people like to mark up method names in MarkDown style block quotes, like this: ruby/ruby#12333.
Currently, no links are created in the code in the RDoc, but such words most likely refer to methods.
This PR makes a word a code cross-reference if the whole word can be resolved as a reference.