This project is archived and is in readonly mode.

#6549 ✓wontfix
Chuck J Hardy

Github Readme Escaped

Reported by Chuck J Hardy | March 9th, 2011 @ 06:29 PM

Throughout the Github Readme, Rails seems to be escaped in some places and not in others, which is generally used in Non-Verbatim Text Escaping. It is a small thing and if incorrect would be great to see changed.

Comments and changes to this ticket

  • Diego Carrion

    Diego Carrion March 9th, 2011 @ 08:48 PM

    They're not escaped, the \ indicates that RDoc should not link automatically the following word.

  • Xavier Noria

    Xavier Noria March 9th, 2011 @ 09:24 PM

    • State changed from “new” to “wontfix”
    • Assigned user set to “Xavier Noria”
    • Importance changed from “” to “Low”

    Problem is that the main page of the API is the README, which is also the main page on GitHub. I plan to change that.

    If you do not escape, the main page of the API (and other RDoc chunks) is full of links to the Rails module in places where we are talking about the Rails framework.

    I close with wontfix (now).

Create your profile

Help contribute to this project by taking a few moments to create your personal profile. Create your profile »

<h2 style="font-size: 14px">Tickets have moved to Github</h2>

The new ticket tracker is available at <a href=""></a>