Lighthouse has a new layout. Prefer the old one? Return to the old layout, and switch back any time from the link at the top of each page.

This project is archived and is in readonly mode.

Fail to generate rdoc for ActionView::Helpers::TextHelper

#5754

rdoc 2.5.11 fails to generate documentation for ActionView::Helpers::TextHelper.

Here's a patch that solves the problem.

Reported by Andrei Kulakov · October 3rd, 2010 @ 11:44 PM

State: stale
Milestone: none
Assigned to: nobody
Importance: Low

Activity

  1. Ben Mills
    Ben Mills

    -1

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

    October 6th, 2010 @ 06:16 AM

  2. Jeff Kreeftmeijer
    Jeff Kreeftmeijer
    • 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.

    October 6th, 2010 @ 08:06 PM

  3. Jeff Kreeftmeijer
    Jeff Kreeftmeijer
    • State changed from new to open
    • Tag changed from actionview, rdoc to actionview, patch, rdoc

    October 7th, 2010 @ 08:06 AM

  4. Andrei Kulakov
    Andrei Kulakov

    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.

    October 7th, 2010 @ 09:50 PM

  5. Jeff Kreeftmeijer
    Jeff Kreeftmeijer
    • 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 :)

    October 9th, 2010 @ 11:53 AM

  6. Andrea Campi
    Andrea Campi

    +1 indeed, NaN% can't be right

    October 9th, 2010 @ 06:39 PM

  7. Ryan Bigg
    Ryan Bigg
    • Tag cleared.

    Automatic cleanup of spam.

    October 11th, 2010 @ 10:55 AM

  8. Ryan Bigg
    Ryan Bigg

    Automatic cleanup of spam.

    October 19th, 2010 @ 08:25 AM

  9. Santiago Pastorino
    Santiago Pastorino

    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.

    February 2nd, 2011 @ 04:48 PM

  10. Santiago Pastorino
    Santiago Pastorino
    • State changed from open to stale

    February 2nd, 2011 @ 04:48 PM