Rails Ruby on Rails

Comments and changes to this ticket

• You flagged this item as spam.
  

  Ben Mills October 6th, 2010 @ 06:16 AM

  -1

  Generates docs correctly in Rails master. Docs generated with rake doc:rails.

• 

  Jeff Kreeftmeijer October 6th, 2010 @ 08:06 PM

  • Tag changed from “rdoc texthelper” to “actionview, rdoc”
  • Importance changed from “” to “Low”

  Ben, you're right. The docs get generated correctly. However, in the docs it generates it omits the ERB tags Andrei escaped in his patch:

  • The preferred method of outputting text in your views is to use the eRuby syntax.

  Should be:

  • The preferred method of outputting text in your views is to use the <%= "text" %> eRuby syntax.

  Andrei's patch seems broken and didn't work for me, giving me a file not found error when trying to apply:

  error: text_helper.rb: No such file or directory
  

  Applying his changes manually didn't work either (it still stripped out the erb tags), so I wrapped them in <tt> tags. I couldn't retain Andrei's ownership, because I didn't know his email address but here's a patch that fixes the issue.

  • text_helper_docs.diff 1.3 KB
• 

  Jeff Kreeftmeijer October 7th, 2010 @ 08:06 AM

  • State changed from “new” to “open”
  • Tag changed from “actionview, rdoc” to “actionview, patch, rdoc”

• You flagged this item as spam.
  

  Andrei Kulakov October 7th, 2010 @ 09:50 PM

  Sorry for broken patch.

  In my case rdoc fails to generate documentation for ActionView::Helpers::TextHelper when i install Rails as gem or run
  @@@gem rdoc actionpack

  after Rails installed as gem without rdoc.
  
  
  
  
  
  
  
  On Rails master when i run
  @@@rake rdoc
  

  everything works and i get documentation for ActionView::Helpers::TextHelper.

  But running
  @@@rdoc actionpack/lib/action_view/helpers/text_helper.rb

  yields
  @@@Parsing sources...
  100% [ 1/ 1]  actionpack/lib/action_view/helpers/text_helper.rb               
  
  
  
  
  
  
  
  
  
  No newer files.
  
  
  
  
  
  
  
  Files:         1
  Classes:       0 (    0 undocumented)
  Constants:     0 (    0 undocumented)
  Modules:       0 (    0 undocumented)
  Methods:       0 (    0 undocumented)
     NaN% documented
  
  
  
  
  
  
  
  Elapsed: 0.0s
  

  It fails even with Jeff's patch.

  I supply new patch that solves the issue for me.

  • text_helper_rdoc.patch 1.2 KB
• 

  Jeff Kreeftmeijer October 9th, 2010 @ 11:53 AM

  • Tag changed from “actionview, rdoc” to “actionview, patch, rdoc”

  Aha! Now I get it.

  Like Andrei explained:

  rdoc actionpack/lib/action_view/helpers/text_helper.rb
  

  doesn't generate anything in master, but his patch fixes the issue and applies cleanly to master. Sorry, I totally misunderstood the issue.

  +1 :)

• You flagged this item as spam.
  

  Andrea Campi October 9th, 2010 @ 06:39 PM

  +1 indeed, NaN% can't be right

• 

  Ryan Bigg October 11th, 2010 @ 10:55 AM

  • Tag cleared.

  Automatic cleanup of spam.

• 

  Ryan Bigg October 19th, 2010 @ 08:25 AM

  Automatic cleanup of spam.

• 

  Santiago Pastorino February 2nd, 2011 @ 04:48 PM

  This issue has been automatically marked as stale because it has not been commented on for at least three months.

  The resources of the Rails core team are limited, and so we are asking for your help. If you can still reproduce this error on the 3-0-stable branch or on master, please reply with all of the information you have about it and add "[state:open]" to your comment. This will reopen the ticket for review. Likewise, if you feel that this is a very important feature for Rails to include, please reply with your explanation so we can consider it.

  Thank you for all your contributions, and we hope you will understand this step to focus our efforts where they are most helpful.

• 

  Santiago Pastorino February 2nd, 2011 @ 04:48 PM

  • State changed from “open” to “stale”