rdoc icon indicating copy to clipboard operation
rdoc copied to clipboard

Autolink text in fixed-width font

Open fxn opened this issue 10 years ago • 2 comments

RDoc autolinks text without markup and removes a leading hash if there is one.

That's a great feature, but if you have for example method or class names that cannot be autolinked, either you use a hash and regular text (which would still leave true or User to be confusing mixed with regular text), or switch to fixed-width font (inconsistent with the autolinked ones).

Fixed-width font is a very common convention for method names, constants, nil, etc. in rich-formatted docs like books. Visually the reader sees that save is a method or variable name, rather than the English word "save", you know.

Would it be possible that RDoc autolinks and respects the font in +...+ or <tt>...</tt>?

/cc @senny

fxn avatar Nov 07 '15 15:11 fxn

I see what you're getting at, but I'm not sure there is time for this in the next release.

Let's see what we can do after the holidays :)

zzak avatar Dec 22 '15 08:12 zzak

@zzak :+1: thank you man!

fxn avatar Dec 22 '15 09:12 fxn