#5537 Script tag in prototype_helper rdoc causing formatting issue in API - Ruby on Rails

Type	To find
responsible:me	tickets assigned to you
tagged:"@high"	tickets tagged @high
milestone:next	tickets in the upcoming milestone
state:invalid	tickets with the state invalid
created:"last week"	tickets created last week
sort:number, importance, updated	tickets sorted by #, importance or updated
Combine keywords for powerful searching.
Use advanced searching »

This project is archived and is in readonly mode.

#5537 ✓duplicate

Script tag in prototype_helper rdoc causing formatting issue in API

Reported by justin | September 2nd, 2010 @ 09:38 PM

In the doc body found here: http://github.com/rails/rails/blob/master/actionpack/lib/action_vie...

There is a script tag in the middle of a sentence (under class JavaScriptGenerator), just before the words "Ajax response bodies, either in a" and it is causing the documentation for this page to be ruined on the API, found here:

http://api.rubyonrails.org/classes/ActionView/Helpers/PrototypeHelp...

See screenshot.

screen-shot-2010-09-02-at-33811-pm.jpg 86.1 KB

Comments and changes to this ticket

Jeff Kreeftmeijer September 5th, 2010 @ 03:01 PM
I've included a patch that replaces every occurrence of <script> with +script+ in the ActionView::Helpers::PrototypeHelper RDocs.

I wanted to escape the whole tag (including the "<" and ">"), but stuff like + doesn't work. Is there any other way to do this? It could be fixed by doing something like @+<script>+@, but that would make it a lot less readable when reading the actual file instead of the generated RDocs.

Thoughts? :)
- rdoc_html_tag.diff 2.2 KB
David Trasbo September 5th, 2010 @ 07:28 PM
Jeff,

Another option is to wrap <script> in a <tt> tag. I've attached a patch that does just that - it also makes sure to wrap at 80 characters.
David Trasbo September 5th, 2010 @ 07:28 PM
Gah.
- 5537.diff 3.4 KB
You flagged this item as spam.
justin September 5th, 2010 @ 09:11 PM
Thanks guys, so I guess your doc engine changed since it looks like that code doc with the SCRIPT tag has been there for a while.
You flagged this item as spam.
Mark Mulder September 7th, 2010 @ 03:10 PM
It looks like #5520 is the same problem.
David Trasbo September 7th, 2010 @ 03:14 PM
- Assigned user set to “Rohit Arondekar”
Mark,

It is - the commit that #5520 links to was created by me to resolve this ticket.

This too can be marked as resolved or duplicate.
Rohit Arondekar September 8th, 2010 @ 02:59 AM
- State changed from “new” to “duplicate”
- Importance changed from “” to “Low”
Repository October 29th, 2010 @ 07:28 AM
(from [ddf73603c1aeb6be3fd8619c7c0054d4cd6528c8]) Backport of documentation fixes:

cfc8c7ab54173c4f28776a69de23028d771f6e24 dfebdb1b033c033b7a39615a39d9d4ac3052e61d

[#5520] [#5537] [#5581] http://github.com/rails/rails/commit/ddf73603c1aeb6be3fd8619c7c0054...