[Ruby] rdoc S.T.B.

[Eric Hodel]

On Apr 26, 2007, at 17:03, James Hillyerd wrote:
> On 4/26/07, Laurel Fan <laurel.fan at gmail.com> wrote:
>> On 4/26/07, Daevid Vincent <daevid at daevid.com> wrote:
>>> RDoc failure in
>>> gems/1.8/gems/rails-1.1.6
>> /lib/rails_generator/generators/components/controll
>>> er/templates/controller.rb at or around line 10 column 4
>>>
>>> Before reporting this, could you check that the file
>>> you're documenting compiles cleanly--RDoc is not a
>>> full Ruby parser, and gets confused easily if fed
>>> invalid programs.
>>
>> Generator templates are definitely invalid programs (as you can tell
>> with all that erb stuff in them).
>> So you should probably exclude them from rdoc.  Is there any chance
>> that rails has a rake task that builds the docs and knows what to
>> exclude?  (caveat: I've never built the rdoc, I just use google or
>> gotapi...)
>
> Rails does have a rake task to build the doc, but it's broken in  
> 1.2.2 and
> 1.2.3 as far as I know.  Last time I searched on how to fix it, I  
> couldn't
> find anyone that had.

Just install the gems.  They get it right:

$ ri ActionController::Base
------------------------------------------ Class: ActionController::Base
      Action Controllers are the core of a web request in Rails. They
      are made up of one or more actions that are executed on request
      and then either render a template or redirect to another action.
      An action is defined as a public method on the controller, which
      will automatically be made accessible to the web-server through
      Rails Routes.