Repository navigation
Monkey patch ToHtmlCrossref to modify ref links - #297
Conversation
Prior to this commit, postprocessing was used to unlink unintentional ref links and style unstyled code ref links. Postprocessing only affects the final generator output, which is generally more robust. But in these cases, it would be more consistent for intermediate consumers of `RDoc::CodeObject#description` to also see these changes. This commit instead monkey patches `RDoc::Markup::ToHtmlCrossref` so that it returns bare text for unintentional ref links and wraps unstyled code ref links with `<code></code>`. Monkey patching RDoc is not ideal, but it allows all consumers of `RDoc::CodeObject#description` to see these changes.
|
@jonathanhefner This breaks builds with newer RDoc (6.10.0+), could you take a look please? 🙇 We might be able to upstream this patch if we can make it configurable. |
|
At a quick glance, it seems ruby/rdoc#1259 breaks this but added the somewhat similar functionality upstream (although a list has to be provided of terms not to link). |
|
@jonathanhefner Thanks for the quick fix and your investigation.
I don't have access to the repo since it moved to the Rails org, so I'm not sure. I just checked and it looks like the transfer happened around March 2023, so they were definitely running after that. 🤔 |
|
Hmm, I checked the GitHub Actions tab, and saw this:
So I clicked "Enable workflow". I can understand automatically disabling the nightly runs, but disabling the action on PRs seems presumptuous... |
|
Good catch, I didn't even realize (or forgot) there was a nightly but we probably don't need it? |
Prior to this commit, postprocessing was used to unlink unintentional ref links and style unstyled code ref links. Postprocessing only affects the final generator output, which is generally more robust. But in these cases, it would be more consistent for intermediate consumers of
RDoc::CodeObject#descriptionto also see these changes.This commit instead monkey patches
RDoc::Markup::ToHtmlCrossrefso that it returns bare text for unintentional ref links and wraps unstyled code ref links with<code></code>. Monkey patching RDoc is not ideal, but it allows all consumers ofRDoc::CodeObject#descriptionto see these changes.