Frederick Cheung
2008-Jul-03 09:14 UTC
Missing documentation problem in ActionController::Filters
I was just pointing someone at some documentation when I noticed that http://api.rubyonrails.com/classes/ActionController/Filters/ClassMethods.html is missing the whole conceptual level chunk that used to sit at the top. I''m not an rdoc expert but my reading of it is that the long intro to filters comment used to be followed by the ClassMethods module, but it''s now followed by an internal implementation detail class which is marked nodoc and that section of documentation gets discarded. Moving the ClassMethods module back to the top rectifies this, but maybe someone who knows more about rdoc than me knows what the best way out is? Fred --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Ruby on Rails: Core" group. To post to this group, send email to rubyonrails-core@googlegroups.com To unsubscribe from this group, send email to rubyonrails-core-unsubscribe@googlegroups.com For more options, visit this group at http://groups.google.com/group/rubyonrails-core?hl=en -~----------~----~----~----~------~----~------~--~---
Jeremy Kemper
2008-Jul-04 20:03 UTC
Re: Missing documentation problem in ActionController::Filters
On Thu, Jul 3, 2008 at 2:14 AM, Frederick Cheung <frederick.cheung@gmail.com> wrote:> > I was just pointing someone at some documentation when I noticed that http://api.rubyonrails.com/classes/ActionController/Filters/ClassMethods.html > is missing the whole conceptual level chunk that used to sit at the top. > > I''m not an rdoc expert but my reading of it is that the long intro to > filters comment used to be followed by the ClassMethods module, but > it''s now followed by an internal implementation detail class which is > marked nodoc and that section of documentation gets discarded. Moving > the ClassMethods module back to the top rectifies this, but maybe > someone who knows more about rdoc than me knows what the best way out > is?Fixed in http://github.com/rails/rails/commit/271f5b6 -- thanks! jeremy --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Ruby on Rails: Core" group. To post to this group, send email to rubyonrails-core@googlegroups.com To unsubscribe from this group, send email to rubyonrails-core-unsubscribe@googlegroups.com For more options, visit this group at http://groups.google.com/group/rubyonrails-core?hl=en -~----------~----~----~----~------~----~------~--~---
Frederick Cheung
2008-Jul-05 11:40 UTC
Re: Missing documentation problem in ActionController::Filters
> > Fixed inhttp://github.com/rails/rails/commit/271f5b6-- thanks!Awesome! Fred --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Ruby on Rails: Core" group. To post to this group, send email to rubyonrails-core@googlegroups.com To unsubscribe from this group, send email to rubyonrails-core-unsubscribe@googlegroups.com For more options, visit this group at http://groups.google.com/group/rubyonrails-core?hl=en -~----------~----~----~----~------~----~------~--~---