Simon Turvey
2005-Oct-07 19:02 UTC
ActiveRecord::ConnectionAdapters::Column documentation missing.
I''m gently working through the Agile book to learn the Rails way and came across the following: Page 63: 6.4 Iteration A4: Prettier Listings The line: <% for column in Product.content_columns %> <th><%= column.human_name %></th> piqued my curiosity sufficiently to send me scurrying to the documentation for more information. Sadly, there seems to be no documentation for the Column class and I had to resort to the source. Is there a documentation roadmap or issue category for missing documentation I can raise this omission under? Cheers, Simon
Ezra Zygmuntowicz
2005-Oct-07 19:48 UTC
Re: ActiveRecord::ConnectionAdapters::Column documentation missing.
On Oct 7, 2005, at 12:02 PM, Simon Turvey wrote:> > I''m gently working through the Agile book to learn the Rails way > and came across the following: > > Page 63: 6.4 Iteration A4: Prettier Listings > > The line: > > <% for column in Product.content_columns %> > <th><%= column.human_name %></th> > > piqued my curiosity sufficiently to send me scurrying to the > documentation for more information. Sadly, there seems to be no > documentation for the Column class and I had to resort to the source. > > Is there a documentation roadmap or issue category for missing > documentation I can raise this omission under? > > Cheers, > > Simon > > _______________________________________________ > Rails mailing list > Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org > http://lists.rubyonrails.org/mailman/listinfo/rails > >In this instance column is just a variable that Product.content_columns gets assigned to. So there is no column class per say. And the human_name method takes the name of a field in your database and capitalizes the first letter and turns underscores into spaces for a more ''humanized'' column name.> <% for column in Product.content_columns %> > <th><%= column.human_name %></th>HTH- -Ezra Zygmuntowicz Yakima Herald-Republic WebMaster http://yakimaherald.com 509-577-7732 ezra-gdxLOakOTQ9oetBuM9ipNAC/G2K4zDHf@public.gmane.org
Simon Turvey
2005-Oct-07 20:22 UTC
Re: ActiveRecord::ConnectionAdapters::Column documentation missing.
Ezra Zygmuntowicz wrote:> In this instance column is just a variable that Product.content_columns > gets assigned to. So there is no column class per say.Well, you''re both right and wrong. There is no Column class but there sure are plenty of objects of type Column; they''re returned by ActiveRecord::Base.content_columns.> And the > human_name method takes the name of a field in your database and > capitalizes the first letter and turns underscores into spaces for a > more ''humanized'' column name.I appreciate the time you''ve taken to respond but I understand this. My issue is more with the absence of documentation, the reason for the absence, where I might raise an appropriate defect to get the absence fixed, and indeed, how I might submit a patch adding documentation. It seemed that as the use of the Column class in the ''Agile'' book appears quite early, i.e. in the section on generating and replacing scaffolding it might be a good idea to actually understand what it was doing. This might be tricky without appropriate documentation to refer to. Simon.
rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org
2005-Oct-07 21:05 UTC
Re: Re: ActiveRecord::ConnectionAdapters::Column documentation missing.
Hi ! Simon Turvey said the following on 2005-10-07 16:22:> I appreciate the time you''ve taken to respond but I understand this. My > issue is more with the absence of documentation, the reason for the > absence, where I might raise an appropriate defect to get the absence > fixed, and indeed, how I might submit a patch adding documentation.In fact, that has already been done, for quite a few of the AbstractAdapter methods. See ticket #2250[1] Bye ! François [1] http://dev.rubyonrails.com/ticket/2250
Simon Turvey
2005-Oct-07 21:46 UTC
Re: ActiveRecord::ConnectionAdapters::Column documentation missing.
rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org wrote:> Hi ! > > Simon Turvey said the following on 2005-10-07 16:22: >> I appreciate the time you''ve taken to respond but I understand this. >> My issue is more with the absence of documentation, the reason for the >> absence, where I might raise an appropriate defect to get the absence >> fixed, and indeed, how I might submit a patch adding documentation. > > In fact, that has already been done, for quite a few of the > AbstractAdapter methods. See ticket #2250[1] > > Bye ! > François > > [1] http://dev.rubyonrails.com/ticket/2250Very cool. Great that it''s update for trunk too. It also handily illustrates the way to raise a defect on documentation too ;-) Cheers, Simon