Skip to content

Autolink text in fixed-width font #370

Open

Description

@fxn

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

Activity

  1. zzak commented on Dec 22, 2015

    @zzak
    Member

    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 :)

  2. added this to the Future milestone on Dec 22, 2015
  3. fxn commented on Dec 22, 2015

    @fxn
    Author

    @zzak 👍 thank you man!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions