Style unstyled code ref links #255
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
RDoc does not provide syntax to style manual code ref links with
`<code></code>`. Wrapping code ref links in `<tt></tt>` or `++` does
not give the desired result. For example,
```ruby
# {<tt>Rails</tt>}[rdoc-ref:Rails]
```
is rendered as
```html
{<code>Rails</code><a href="..."><code>}</code></a>
```
and
```ruby
# <tt>{Rails}[rdoc-ref:Rails]</tt>
```
is rendered as
```html
<code>{Rails}[rdoc-ref:Rails]</code>
```
This commit uses postprocessing to style unstyled code ref links that
look like code. If the link text does not contain a space or if it
matches `/\S\(/` (e.g. `foo(bar, &block)`), it is assumed to be code,
and the text is then wrapped with `<code></code>`.
This complements 4837fea in that it
allows manual code ref links to single-word modules to be styled as if
they were autolinks.
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.
RDoc does not provide syntax to style manual code ref links with
<code></code>. Wrapping code ref links in<tt></tt>or++does not give the desired result. For example,# {<tt>Rails</tt>}[rdoc-ref:Rails]is rendered as
{<code>Rails</code><a href="..."><code>}</code></a>and
# <tt>{Rails}[rdoc-ref:Rails]</tt>is rendered as
This commit uses postprocessing to style unstyled code ref links that look like code. If the link text does not contain a space or if it matches
/\S\(/(e.g.foo(bar, &block)), it is assumed to be code, and the text is then wrapped with<code></code>.This complements 4837fea in that it allows manual code ref links to single-word modules to be styled as if they were autolinks.