[Rails] ActionController::Base doc confusion

[David Heinemeier Hansson]

> The example in ActionController::Base's documentation ends (after the
> class defiinition) with:
>
>   GuestBookController.template_root = "templates/"
>   GuestBookController.process_cgi
>
> I'm not sure why these are shown along with the definition--surely
> these calls are normally made by the framework?

The "problem" is that both Active Record and Action Pack are 
stand-alone frameworks that works well outside the core Rails 
integration as well. Hence, the API docs for then are meant to be so 
complete that it's enough to work with them on their own.

What we should do, though, is highlight when a given piece of 
functionality is handled by Rails. Then Rails readers can choose to 
move on while people just using that framework can dive in.

> P.S. Where should I send comments like these? Is this the right place?
> I don't want to use up too much bandwidth on trivia... (on the other
> hand, I do think that clarity of documentation is important...).

Here is fine.
--
David Heinemeier Hansson,
http://www.basecamphq.com/   -- Web-based Project Management
http://www.rubyonrails.org/  -- Web-application framework for Ruby
http://macromates.com/       -- TextMate: Code and markup editor (OS X)
http://www.loudthinking.com/ -- Broadcasting Brain